README.rst

Kea doc

https://kea-doc.readthedocs.io/en/latest/

Developer Tutorial

1.Set up

git clone git@github.com:XYIheng/kea_doc.git

cd kea_doc/docs

pip install -r requirements.txt

(optional) 2.Use vscode RST previewer

Add the following extension to vscode:

reStructuredText

reStructuredText Syntax highlighting

Esbonio

Install Esbonio server

pip install esbonio

reboot vscode to apply the changes.

3. Build html

cd kea_doc/docs

# You should delete the build dir every time you modify the file structure of the project
# Or the cache will affect the previewer of the esbonio extension.
rm -r build

make html

Template for the Read the Docs tutorial

This GitHub template includes fictional Python library with some basic Sphinx docs.

Read the tutorial here:

https://docs.readthedocs.io/en/stable/tutorial/