mirror of
https://github.com/Mikaela/Limnoria-doc.git
synced 2024-12-26 05:02:37 +01:00
6f3171225d
* Fix typos
* `I already write` --> `I already wrote`.
* `Simple isn't` --> `Simple isn'it it?`
* `Go back on` --> `Go back to`
* `is)files` --> `is) files`
* remove swearing.
* Clone the `testing` branch in the beginning, don't require checkout.
* Added notice on not having to git checkout if testing was cloned.
* Rename `progval` to `upstream`
* If people are contributing to multiple projects, the remote
`upstream` is easier to remember than random nickname.
* I am Mikaela
* and I use git by myself nowadays.
|
||
|---|---|---|
| _templates | ||
| contribute | ||
| develop | ||
| use | ||
| .gitignore | ||
| append_config_doc.py | ||
| conf.py | ||
| generate_plugin_doc.py | ||
| index.rst | ||
| make.bat | ||
| Makefile | ||
| 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.