forked from enlightenment/efl
5585420e85
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 |
||
|---|---|---|
| .. | ||
| api | ||
| default_efl | ||
| .gitignore | ||
| README | ||
| docfx.json | ||
| e-logo-title.png | ||
| filterConfig.yml | ||
| gendoc.sh | ||
| index.md | ||
| setup.sh | ||
| toc.yml | ||
README
EFL DocFX SUPPORT ----------------- DocFX (https://dotnet.github.io/docfx/) generates documentation HTML pages directly from source code and Markdown files for C# projects. Although significantly slow, it is a simple alternative while our own documentation generator for C# is being written. The scripts in this folder create a documentation site which contains the API reference guide and articles with tutorials and guides. The API guide is generated from the EFL mono sources, which are generated as part of the normal build process. The articles are fetched from the EFL www-content repository and adapted to DocFX syntax. USAGE ----- First off, build EFL with C# support enabled so the C# sources are generated (you will need to have mono 5 installed for this). Then, from this folder, run the `setup.sh` script to download and extract the DocFX binaries to the `bin` folder, fetch the articles from the `www-content` repository and adapt them to the DocFX syntax. Finally, run the `gendoc.sh` script (also from this folder) to produce the HTML files. First run can take a long time (from 10' to 1h), subsequent runs use cached results and take about 5 minutes.