Sphinx
=======================================

(Python Documentation Generator)

.. note::

   This project is under active development.

Quick start
--------------

Assuming you have Python already, install Sphinx:
::

    pip install sphinx

windows install sphinx
::

    pip install -U sphinx

Now that you have added some files and content, let’s make a first build of the docs. A build is started with the sphinx-build program:
::

    sphinx-build -b html sourcedir builddir

where sourcedir is the source directory, and builddir is the directory in which you want to place the built documentation. The -b option selects a builder; in this example Sphinx will build HTML files.

Building your HTML documentation
::

    sphinx-build -b html source/ build/html

Install sphinx-rtd-theme
::

    pip install sphinx-rtd-theme

Get Sphinx version
::

    sphinx-build --version

Sphinx Quick start
::

    sphinx-quickstart


`Getting Started with Sphinx <https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html>`_

#. `Sphinx Official Website <https://www.sphinx-doc.org/>`_
#. `Sphinx Github Repository <https://github.com/sphinx-doc/sphinx/>`_
#. `Sphinx Documentation <https://www.sphinx-doc.org/>`_
#. `Sphinx Themes <https://sphinx-themes.org/>`_
#. `Sphinx Extensions <https://sphinx-extensions.readthedocs.io/>`_
#. `Read the Docs <https://readthedocs.org/>`_
#. `reStructuredText Manual <https://restructuredtextmenu.readthedocs.io/>`_
#. `reStructuredText:Markup Syntax and Parser Component of Docutils <https://restructuredtextmenu.readthedocs.io/>`_
#. `Quick reStructuredText <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_
#. `Create Documentation with RST, Sphinx, Sublime, and GitHub <https://docutils.sourceforge.io/rst.html>`_
#. `sphinx-lesson: structured lessons with Sphinx <https://coderefinery.github.io/sphinx-lesson/>`_

read the docs
-------------------
Organizations
ModernCFD
https://github.com/ModernCFD