Usage instructions in the README file.
Details
Follow the README to produce the documentation pages.
Point your browser to docfx/_site/index.html to see the results.
Diff Detail
- Repository
- rEFL core/efl
- Branch
- devs/xartigas/docfx-support
- Lint
No Linters Available - Unit
No Unit Test Coverage - Build Status
Buildable 8608 Build 7651: arc lint + arc unit
Work both with autotools- and meson- generated efl-mono dll.
Why are they called differently, anyway?
Actually, for this to work with meson the docfx.json would need to be generated at configure time from a docfx.json.in. I've created a separate task for that (T7527)
Use source files instead of dll (so the name does not change between meson and autotools) and scan all folders from the root down (so will work for any meson builddir which is a subfolder of root)
docfx/README | ||
---|---|---|
13 | Shouldn't this be updated to something like "The API guide is generated from the EFL mono dll sources and its xmldoc tags"? |
Will wait for somebody else's input before landing, as the scripts do several things and are bound to fail in some distro or another,
doc/docfx/setup.sh | ||
---|---|---|
17 ↗ | (On Diff #18163) | I am not too sure if we want to really download here without telling that to the user... The normal way is installation via package manager, i could understand that a few users would be concerned that we *under the hood* download precompiled codes from somewhere, and execute it... The alternative that i can think of is a seperated *install* script and a option to pass the docfx directory to the install script, or the generation script. |
I lied, it seems unlikely that I'll be able to test this. Fedora seems stuck on mono 4.8, which doesn't work with any of this.
OK, thanks @zmike, I'll try to find more "volunteers" for testing.
doc/docfx/setup.sh | ||
---|---|---|
17 ↗ | (On Diff #18163) | Will a "Do you want to proceed with download?" message be enough? |
Hold on I'm attempting to build mono from git, stay tuned to this liveblog feed for continuing updates!