enlightenment
/
edocgen
7
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update readme

This commit is contained in:
Daniel Kolesa 2018-12-17 16:34:43 +01:00
parent e4583ad539
commit 174c099a9b
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README-docgen.md
View File

@ -1,9 +1,13 @@
# docgen
# edocgen
This is the upcoming documentation generator for EFL. It takes documentation
described in Eo files and turns it into a DokuWiki structure (with possibility
of adapting it to other systems later on).
This is the EFL documentation generator. It takes documentation described in
Eo files and turns it into a DokuWiki structure (with possibility of adapting
it to other systems later on).
Use the supplied build.sh script to generate. By default, it assumes that a
directory called "dokuwiki" is present in the current directory, so symlink
your dokuwiki setup into it (or change the path).
To generate documentation, you need a `dokuwiki` directory in the current
path (see `--help` for `gendoc.lua` for how to alter the path). Then run
the `gendoc.lua` script with `elua`, passing a path to eo files to it.
If you don't pass a path, system eo files are used.
Generally it is recommended that you pass it `src/lib` from your EFL tree
and symlink your DokuWiki installation in the current path.