Skip to content

Commit

Permalink
Use code blocks instead of inline
Browse files Browse the repository at this point in the history
  • Loading branch information
stevepiercy committed Jul 3, 2024
1 parent 28608b7 commit 8581d35
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,20 @@ To build the documentation, follow these steps:
You can now open the output from ``_build/html/index.html``.

To build the documentation, view it in a web browser, and automatically reload changes while you edit documentation, use ``make livehtml`` instead of ``make html``.
To build the documentation, view it in a web browser, and automatically reload changes while you edit documentation, use the following command.

.. code-block:: shell
make livehtml
Then open a web browser at `http://127.0.0.1:8050 <http://127.0.0.1:8050>`_.

To build the presentation-version use ``make presentation`` instead of ``make html``.
To build the presentation-version use the following command.

.. code-block:: shell
make presentation
You can open the presentation at ``presentation/index.html``.

You can also use ``tox`` to build the documentation:
Expand Down

0 comments on commit 8581d35

Please sign in to comment.