Version 2.45 of DocFX seems much much faster than previous 2.40, but could just
be a matter of stale caches. Anyway, no breakages have been detected.
Using an online symbol resolution server (https://xref.docs.microsoft.com)
adds some more links for .NET symbols (and no noticeable slowdown).
Otherwise, <remarks> section DIV at the namespace level is always
shown, even if empty. And we do not want that now that the DIV has
a background color.
Summary:
The mono generator adds a <remarks> section to all BETA classes with an explanatory text.
These tags are understood by DocFX and Monodevelop.
On top of this, this commit modifies the DocFX template to give the Remarks section a more
prominent place in the page.
Test Plan: Render docs, Beta classes should have a big blue box with a remark about the class being Beta and dangerous.
Reviewers: lauromoura, vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D9381
The setup script copied ALL media files, but only the C# tutorials and guides.
A lot of space can be saved in the generated _site folder if only the media
files relevant to C# are copied.
Reference page titles are now "Class Efl.Ui.Win" instead of "Class Win".
And also remove Namespace and Assembly sections.
Namespace is redundant since we use fully-qualified names everywhere.
Assembly is useless since we build the docs from the source so this entry is
always "temp.dll".
In the EFL API we have several objects with the same name in different namespaces.
Thus it is important to use fully-qualified names throughout the docs, to avoid
confusion.
However, the default DocFX templates prefer using only simple class names.
The default templates have already been modified to use full names everywhere
except in the list of derived classes in the hierarchy section, where a DocFX
bug was hit.
This commit is a workaround to that bug (see
https://github.com/dotnet/docfx/issues/3769#issuecomment-485616064 )
so full names (with links) are used in the whole hierarchy.
These classes need to be public so new user-created classes can inherit
from them, but they have the same content as the regular classes.
Therefore there is no need to pollute the documentation with duplicated
elements.
Summary:
These templates add the following features:
- Collapsible sections for simpler reading
- Full class names in ancestors list
(Could not make it work for descendants)
- Removed duplicated Implements section
- Removed huge Inherited Members section
- Extended maximum number of hierarchy levels from 5 to 10
(because our hierarchy is really that big)
Test Plan:
Follow the doc/docfx README to generate the HTML pages and enjoy the improved
and slightly-more-usable docs.
Reviewers: lauromoura, bu5hm4n, zmike, cedric
Reviewed By: lauromoura
Subscribers: #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D7832
Summary: Usage instructions in the README file.
Test Plan:
Follow the README to produce the documentation pages.
Point your browser to docfx/_site/index.html to see the results.
Reviewers: lauromoura, bu5hm4n, cedric, myoungwoon, zmike
Reviewed By: lauromoura, bu5hm4n
Subscribers: #reviewers, #committers
Tags: #efl
Maniphest Tasks: T7424
Differential Revision: https://phab.enlightenment.org/D7502