Skip to content

Documentation page with Sphinx help

Sopapia edited this page Feb 2, 2020 · 4 revisions

How to create your own documentation page with Sphinx

Create a .txt file in ./sphinx, then change to .md.

For Markdown format help, see this site: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

Be sure to add * [Title](name.html) to index.md so you can access your page from the main area.

Building

If you haven't downloaded these, it won't build. In Powershell: pip install sphinx, pip install --upgrade recommonmark, pip install sphinx_rtd_theme, and pip install sphinx-markdown-tables.

To run Sphinx and turn your .md file into a .html file, open a Powershell Window in ./sphinx and type command ./build html (or double click build.bat thanks to Eric)

Clone this wiki locally