Page MenuHomePhabricator

docs: Add custom DocFX templates
ClosedPublic

Authored by segfaultxavi on Jan 30 2019, 10:27 AM.

Details

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.

Diff Detail

Repository
rEFL core/efl
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
segfaultxavi created this revision.Jan 30 2019, 10:27 AM
segfaultxavi requested review of this revision.Jan 30 2019, 10:27 AM

No need to wholly review these new files, they have been copied from DocFX's defaults and modified.
If you want to see the modifications, first you have to obtain DocFX's defaults (from the doc/docfx folder):

mono bin/docfx.exe template export default -o TARGET_FOLDER

Then you can compare (with meld, for instance) the TARGET_FOLDER and default_efl directories to see my actual changes.

Added full names to all types.

This revision is now accepted and ready to land.Feb 11 2019, 5:08 AM
This revision was automatically updated to reflect the committed changes.