Skip to content

Commit

Permalink
Merge pull request #8 from open-contracting/docs-build-instructions
Browse files Browse the repository at this point in the history
Add instructions to build docs locally
  • Loading branch information
jpmckinney committed Oct 1, 2020
2 parents fa8f7d8 + d7f8a1b commit cb99bbd
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/general/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,26 @@ Shell examples
~~~~~~~~~~~~~~

Documentation and examples for external users should use ``sh`` or ``bash``. Documentation for internal users can use ``fish``.

Building documentation locally
--------------------------------

With Python 3 as your default interpreter, first install sphinx:

.. code-block:: bash
pip install sphinx
Then build the HTML pages:

.. code-block:: bash
sphinx-build docs build
Run a web-server:

.. code-block:: bash
python -m http.server 8000
Open http://localhost:8000/build/ in your web browser.

0 comments on commit cb99bbd

Please sign in to comment.