DocumentationΒΆ
Full documentation is available online.
However, you can also build the documentation from source. Enter your virtual environment.
$ source myvenv/bin/activate
Clone the code repository.
(myvenv)$ git clone git@github.com:richardcornish/django-markdowny.git
(myvenv)$ cd django-markdowny/
Install Sphinx, sphinx-autobuild
, and sphinx_rtd_theme
.
(myvenv)$ pip install sphinx sphinx-autobuild sphinx_rtd_theme
Create an HTML build.
(myvenv)$ (cd docs/ && make html)
Or use sphinx-autobuild
to watch for live changes.
(myvenv)$ sphinx-autobuild docs/ docs/_build_html
Open 127.0.0.1:8000.