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
30 Commits 2 Branches 0 Tags 723 KiB
Python 45.3%
Makefile 27.7%
Batchfile 26.3%
HTML 0.5%
Shell 0.2%
0f54191c42
Go to file
Valentin Lorentz 0f54191c42 Merge pull request #1 from Mkaysi/master 
Use "python setup.py install --user" instead of "python setup.py --prefix=$HOME/.packages/
2012-03-31 08:21:42 -07:00
_templates Add 'project homepage' link. 2011-09-02 10:45:46 +00:00
conf Review and update the layout. 2011-06-28 17:29:38 +02:00
contribute Too many changes to list them. 2011-06-29 19:17:50 +02:00
develop Fix typoes. 2011-10-02 11:54:52 +02:00
import Move the imported files and add HTTP server doc. 2011-07-01 19:03:35 +02:00
use use/install.rst: Advise to use "python setup.py install --user". 2012-03-31 18:16:34 +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 Review and update the layout. 2011-06-28 17:29:38 +02: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 Fix doctrees. 2011-06-30 16:49:28 +02: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.