Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2025-02-17 05:50:55 +01:00
Code Issues Projects Releases Wiki Activity
Limnoria-doc/README.md
Mikaela Suomalainen 00737ebf49 README.md: multiple fixes 
* Convert to markdown.
* Fix grammar.
* Fix link to generated documentation (supybot.fr.cr --> supybot.aperio.fr).
2014-06-30 20:22:05 +03:00

616 B
Raw Blame History

To generate the html doc from the .rst files, run make html. You need the Sphinx documentation generator to do that. A generated doc is available at http://supybot.aperio.fr/doc/.

The .rst files in use/plugins/ have been generated once by generate_plugin_doc.py and append_config_doc.py (I may have modified them temporarily to match my file hierarchy). All of them has been reviewed and modified by hand: include unofficial.inc if needed, and the second-level titles, sort commands by type, … Don’t even think about running those scripts again on a generated documentation, it would overwrite it.