Limnoria-doc

mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-08 00:09:46 +00:00

Go to file

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

_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

use/install.rst: simplify installation/upgrading

2014-06-30 15:25:11 +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.md

README.md: multiple fixes

2014-06-30 20:22:05 +03:00

README.md

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.

Languages

Python 45.4%

Makefile 27.7%

Batchfile 26.2%

HTML 0.5%

Shell 0.2%