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)

segfaultxavi added a reviewer: zmike.Dec 27 2018, 4:08 AM

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)

Harbormaster completed remote builds in B8591: Diff 18120.Dec 27 2018, 4:35 AM

segfaultxavi mentioned this in T7527: Support DocFX from meson.Dec 27 2018, 4:52 AM

Added EFL icon and favicon

Harbormaster completed remote builds in B8592: Diff 18121.Dec 27 2018, 7:02 AM

lauromoura added inline comments.Dec 28 2018, 9:55 AM

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"?

More precise README

Harbormaster completed remote builds in B8606: Diff 18138.Dec 28 2018, 10:24 AM

segfaultxavi marked an inline comment as done.Dec 28 2018, 10:25 AM

Include note about mono in the README

Harbormaster completed remote builds in B8607: Diff 18139.Dec 28 2018, 10:28 AM

Fix arc mess, doh!

Harbormaster completed remote builds in B8608: Diff 18140.Dec 28 2018, 10:28 AM

lauromoura accepted this revision.Dec 28 2018, 10:43 AM

This revision is now accepted and ready to land.Dec 28 2018, 10:43 AM

Move docfx folder inside doc, where it makes more sense.

Harbormaster completed remote builds in B8630: Diff 18163.Dec 30 2018, 8:20 AM

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,

I'm working on testing this.

bu5hm4n added inline comments.Jan 2 2019, 10:34 AM

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? DocFX does not appear in my `apt search`. I am not too concerned about this since the use case for these scripts is: I execute them, obtain the HTML files, commit them somewhere, and end of the story.

Hold on I'm attempting to build mono from git, stay tuned to this liveblog feed for continuing updates!

it worked for me

@zmike See you in 4 months!

Detect mono version and skip DocFX download if bin folder already exists.

Harbormaster completed remote builds in B8693: Diff 18254.Jan 7 2019, 7:45 AM

Closed by commit rEFL2d8f3fba4644: doc: Add support for DocFX (C# doc generator) (authored by segfaultxavi). · Explain WhyJan 7 2019, 8:07 AM

This revision was automatically updated to reflect the committed changes.

segfaultxavi mentioned this in T7424: Add support for DocFx to generate the C# API docs.Jan 7 2019, 8:16 AM

			Path
A	M		docfx/.gitignore (11 lines)
A	M		docfx/README (28 lines)
A	M		docfx/api/.gitignore (5 lines)
A	M		docfx/api/index.md (5 lines)
A	M		docfx/docfx.json (73 lines)
A	M	(img)	docfx/e-logo-title.png
A	M		docfx/filterConfig.yml (7 lines)
A	M		docfx/gendoc.sh (26 lines)
A	M		docfx/index.md (2 lines)
A	M		docfx/setup.sh (86 lines)
A	M		docfx/toc.yml (5 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	18062	8fa3f39		Dec 21 2018, 7:38 AM	★	★
Diff 2	18063	8fa3f39	Added the "Fixes" tag	Dec 21 2018, 7:41 AM	★	★
Diff 3	18064	8fa3f39	Make sure the "images" folder exists and it's empty.	Dec 21 2018, 7:53 AM	★	★
Diff 4	18065	8fa3f39	Work both with autotools- and meson- generated efl-mono dll.	Dec 21 2018, 8:14 AM	★	★
Diff 5	18120	8fa3f39	Use source files instead of dll (so the name does not change between meson and…	Dec 27 2018, 4:34 AM	★	★
Diff 6	18121	8fa3f39	Added EFL icon and favicon	Dec 27 2018, 7:02 AM	★	★
Diff 7	18138	fe05e55	More precise README	Dec 28 2018, 10:24 AM	★	★
Diff 8	18139	8fa3f39	Include note about mono in the README	Dec 28 2018, 10:27 AM	★	★
Diff 9	18140	fe05e55	Fix arc mess, doh!	Dec 28 2018, 10:28 AM	★	★
Diff 10	18163	fe05e55	Move docfx folder inside doc, where it makes more sense.	Dec 30 2018, 8:20 AM	★	★
Diff 11	18254	fe05e55	Detect mono version and skip DocFX download if bin folder already exists.	Jan 7 2019, 7:45 AM	★	★
Diff 12	18255	71776d2	rEFL2d8f3fba464411329eadcf41d02d542f2f4e339c	Jan 7 2019, 8:07 AM	★	★

doc: Add support for DocFX (C# doc generator)
ClosedPublic
Actions

Details

Diff Detail

Revision Contents
Changeset List

Diff 18140

docfx/.gitignore

docfx/README

docfx/api/.gitignore

docfx/api/index.md

docfx/docfx.json

docfx/e-logo-title.png

docfx/filterConfig.yml

docfx/gendoc.sh

docfx/index.md

docfx/setup.sh

docfx/toc.yml

doc: Add support for DocFX (C# doc generator)ClosedPublicActions