sphinxSimDoc¶
A collection of simple docs built from scratch using sampledocs from Sphinx and also by using Sphinx.
Details¶
| Author: | Anirban Roy Das |
|---|---|
| Email: | anirban.nick@gmail.com |
| Copyright(C): | 2016, Anirban Roy Das <anirban.nick@gmail.com> |
Check sphinxSimDoc/LICENSE file for full Copyright notice.
Overview¶
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.
Sphinx is far and away the most popular Python documentation tool. Use it. It converts reStructuredText markup language into a range of output formats including HTML, LaTeX (for printable PDF versions), manual pages, and plain text.
reStructuredText¶
Most Python documentation is written with reStructuredText. It’s like Markdown with all the optional extensions built in.
The reStructuredText Primer and the reStructuredText Quick Reference should help you familiarize yourself with its syntax.
Technical Specs¶
| sphinx: | The Documentation building tool |
|---|---|
| python: | The python language implementation |
| pip: | The python package installation tool (Optional but recommended) |
Installation¶
pip install sphinx
For installing pip, follow the bellow methods:
- Method 1 - https://pip.pypa.io/en/stable/installing/
- Method 2 - http://ask.xmodulo.com/install-pip-linux.html
- Method 3 - If you installed python on MAC OS X via
brew install python, then pip is already installed along with python.
Usage¶
Go to the documentation page created by this documentation itself, its recursive, but the documentation helps in created this doumentation itself.
TODO¶
- Add Blog Post regarding this topic.