Skip to content

Commit

Permalink
[Docs] Fix installation steps
Browse files Browse the repository at this point in the history
  • Loading branch information
lchrusciel committed Feb 24, 2020
1 parent 9b3885c commit f1216f0
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,15 @@ Our recommendation is to install ``Sphinx`` via `Pip`_.

.. code-block:: bash
$ pip3 install -U sphinx
$ pip3 install sphinx_copybutton
$ pip3 install --no-cache-dir -r ./docs/requirements.txt
Then run ``sphinx-build -b html ./docs ./docs/build`` and view the generated HTML files in the ``docs/build`` directory. You can open them in your browser and check how they look!
Then run

.. code-block:: bash
sphinx-build -b html ./docs ./docs/build
and view the generated HTML files in the ``docs/build`` directory. You can open them in your browser and check how they look!

.. warning::

Expand Down

0 comments on commit f1216f0

Please sign in to comment.