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

README.md: multiple fixes

Browse Source 
* Convert to markdown.
* Fix grammar.
* Fix link to generated documentation (supybot.fr.cr --> supybot.aperio.fr).
This commit is contained in:
Mikaela Suomalainen 2014-06-30 20:22:05 +03:00
parent 77613cbf7d
commit 00737ebf49
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README
View File

@ -1,11 +0,0 @@
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.

11
README.md Normal file
View File

@ -0,0 +1,11 @@
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.