README.md

Hosted At

https://docs.kodethon.com

Getting Started

First install python pip, for example:

sudo apt-get install python-pip

Next install Sphinx:

Installing Sphinx via MacPorts

$ sudo port install py36-sphinx

$ sudo port select --set python python36
$ sudo port select --set sphinx py36-sphinx

Installing Sphinx via Homebrew

$ brew install sphinx-doc

Installing Sphinx via apt-get

$ sudo apt-get install python-sphinx

Install Sphinx Dependencies via Pip

sudo pip install sphinxcontrib-httpdomain
sudo pip install sphinx_rtd_theme

Usage

Make sure you are in the respository root and then run:

make html

Files will be generated in the 'build' folder.