Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-11-23 04:29:32 +01:00
Code Issues Projects Releases Wiki Activity
59 Commits 2 Branches 0 Tags 723 KiB
Python 45.3%
Makefile 27.7%
Batchfile 26.3%
HTML 0.5%
Shell 0.2%
514b430879
Go to file
Valentin Lorentz 514b430879 Document SIGHUP.
2014-01-20 10:27:16 +01:00
_templates Add 'project homepage' link. 2011-09-02 10:45:46 +00:00
contribute Fix path of translations (locale -> locales). 2013-05-24 20:11:51 +02:00
develop Fix typo in develop/advanced_plugin_config.rst. 2014-01-20 10:27:07 +01:00
use Document SIGHUP. 2014-01-20 10:27:16 +01:00
.gitignore First commit 2011-06-26 17:10:12 +02:00
append_config_doc.py Edit the script to generate the doc for unofficial plugins. 2011-10-29 13:28:46 +02:00
conf.py Enhance doc of irclib and callbacks. 2013-02-01 17:52:54 +01:00
generate_plugin_doc.py Edit the script to generate the doc for unofficial plugins. 2011-10-29 13:28:46 +02:00
index.rst Move develop/plugins.rst to develop/index.rst. 2013-01-31 19:08:21 +01:00
make.bat First commit 2011-06-26 17:10:12 +02:00
Makefile First commit 2011-06-26 17:10:12 +02:00
README Add README. 2011-10-29 13:58:49 +02:00

README 

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.fr.cr/doc/>.

The .rst files in use/plugins/ has been generate *once* by
`generate_plugin_doc.py` and `append_config_doc.py` (I may have modified them
temporaly 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 that scripts again on a generated doc, it would
overwrite it.