Limnoria-doc

mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-12-26 05:02:37 +01:00

Go to file

Valentin Lorentz 4f0bcd4a43 Merge pull request #5 from Mkaysi/install.rst Document installing with pip.		2014-06-27 19:16:20 +02:00
_templates	Add 'project homepage' link.	2011-09-02 10:45:46 +00:00
contribute	contribute/translate.rst: I am Mikaela! (And other fixes).	2014-06-07 21:28:08 +03:00
develop	Fix typo.	2014-01-26 22:31:46 +01:00
use	install.rst: Do changes suggested by @ProgVal & add upgrading with pip.	2014-06-27 20:02:15 +03: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	Update copyright date.	2014-01-20 11:39:58 +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.