Commit Graph

4 Commits

Author SHA1 Message Date
Xavi Artigas faaba156ab docfx: Remove collapsible sections
They didn't render correctly in all cases.
2019-07-05 17:06:39 +02:00
Xavi Artigas 6547d45b81 mono-docs: Use full name in page title
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".
2019-04-23 11:07:29 +02:00
Xavi Artigas 8e3fa3a97f mono-docs: Use full name in list of derived classes
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.
2019-04-23 10:51:56 +02:00
Xavi Artigas 133b659b73 docs: Add custom DocFX templates
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
2019-02-11 14:18:12 +01:00