Limnoria
/
Limnoria-doc
mirror of https://github.com/Limnoria/Limnoria-doc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Mirror of Limnoria's documentation's source. https://github.com/Limnoria/Limnoria-doc.git
354 Commits 2 Branches 0 Tags 867 KiB
Python 45.3%
Makefile 27.7%
Batchfile 26.3%
HTML 0.5%
Shell 0.2%
Go to file
James Lu f6dd63f6b8 style: remove import ordering clause 
I think this is quite silly and makes imports harder to find for little gain.
While PEP8 doesn't say anything about input order directly, many style guides have converged[1] on sorting alphabetically (after grouping by module type).
I don't follow this in any of my contributed code and I don't think anyone has ever noticed or cared.

[1]: https://stackoverflow.com/a/20763446
 		2023-04-29 11:09:29 -07: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 update links http -> https & fix linkrots 2021-06-29 17:41:51 +02:00
develop style: remove import ordering clause 2023-04-29 11:09:29 -07:00
locale/fr/LC_MESSAGES Freenode -> Libera 2021-07-17 20:44:55 +02:00
use install: Remove references to FreeBSD ports 2023-04-26 17:56:01 +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 update links http -> https & fix linkrots 2021-06-29 17:41:51 +02: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
glossary.rst Start writing a glossary 2021-10-02 15:22:19 +02:00
index.rst Start writing a glossary 2021-10-02 15:22:19 +02:00
make.bat update links http -> https & fix linkrots 2021-06-29 17:41:51 +02: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/