Limnoria-doc

Go to file

Valentin Lorentz 008b183f28 Make the plugin list a definition-list instead of the raw toctree to show a short description of each plugin, instead of just the long list of names.		2021-04-17 17:59:02 +02:00
_static	Update use/faq.rst && add _static/	2014-12-28 09:51:46 +02:00
_templates	Add 'project homepage' link.	2011-09-02 10:45:46 +00:00
contribute	contribute/develop: typo fixes	2020-03-18 23:42:04 -07:00
develop	Make the plugin list a definition-list instead of the raw toctree	2021-04-17 17:59:02 +02:00
locale/fr/LC_MESSAGES	fix minor typo	2019-10-18 21:48:21 +02:00
use	Rewrite the plugin doc generation script so it actually works.	2021-04-11 11:34:14 +02:00
.gitignore	Rewrite the plugin doc generation script so it actually works.	2021-04-11 11:34:14 +02:00
.travis.yml	update .travis.yml	2014-12-28 08:39:50 +02:00
Makefile	Regenerate Makefile and make.bat.	2016-02-24 17:44:21 +01:00
README.md	Update readme	2021-04-11 20:37:11 +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	Hide version number, it's not relevant.	2020-04-26 12:30:18 +02:00
conf_fr.py	Add French localisation.	2016-02-24 21:05:35 +01:00
generate_plugin_doc.py	Make the plugin list a definition-list instead of the raw toctree	2021-04-17 17:59:02 +02:00
index.rst	Add an introduction.	2020-05-08 19:27:56 +02:00
make.bat	Regenerate Makefile and make.bat.	2016-02-24 17:44:21 +01:00
requirements.txt	requiremets.txt: add sphinx_rtd_theme &&	2014-08-31 15:00:30 +03:00
update_locales.sh	Add French localisation.	2016-02-24 21:05:35 +01:00

README.md

To generate the html doc from the .rst files, run these commands:

pip3 install limnoria
git clone https://github.com/Limnoria/Limnoria-doc.git
cd Limnoria-doc
./generate_plugin_doc.py
make html

You need the Sphinx documentation generator to do that. A generated doc is available at https://docs.limnoria.net/