.. _sphinx:

######
Sphinx
######

.. rubric:: Sphinx makes it easy to create intelligent and beautiful documentation.

Requirements (sphinx)
=====================

.. code-block:: shell

   ~ $ command -v sphinx-build
   $LOCAL/bin/sphinx-build
   ~ $ $LOCAL/bin/sphinx-build --version
   sphinx-build ...
   

If the output is empty, then you need to `install Sphinx <#installatin-sphinx>`_

Installation (sphinx)
=====================

.. code-block:: shell

   ~ $ pip install sphinx --user
   Successfully installed sphinx-...

Alternatively, See the official documentation
`Installing Sphinx <https://www.linuxtv.org/downloads/sphinx-1.2.3/install.html>`_

.. note::
   The '--user' option is specified to install into 
   
      $HOME/.local/lib/pythonXX/site-packages

   and the entry point into

      $HOME/.local/bin