Installation and setup

1) Install and setup Sphinx

pip install -U Sphinx

Ref: http://www.sphinx-doc.org/en/master/

2) Clone Project

git clone https://github.com/seopanel/Seo-Panel-Docs.git

3) Build the project

cd Seo-Panel-Docs

make html

It will create build files in the folder => Seo-Panel-Docs/_build/html/

Take the folder in browser like below link

http://localhost/Seo-Panel-Docs/_build/html/

That will show the html output of our project.

4) Developer Notes

Edit .rst files to add changes to the doc during build.

Eg:

Seo-Panel-Docs/plugins.rst Seo-Panel-Docs/plugins/link-diagnosis.rst

Ref: https://matplotlib.org/sampledoc/