Limnoria
/
Limnoria-doc
mirror of https://github.com/Limnoria/Limnoria-doc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme

This commit is contained in:
Valentin Lorentz 2021-04-11 20:37:11 +02:00
parent 71536bc9f9
commit 78030615fb
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,5 +1,12 @@
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
To generate the html doc from the .rst files, run these commands:
* https://limnoria-doc.readthedocs.org/
```
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/