Skip to content

Commit

Permalink
chore: code block added for better readability
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeWithEmad committed Nov 14, 2024
1 parent 57a98a2 commit 69fd5da
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ Before you make a pull request with your proposed changes, please try to visuall

To test locally in a Python virtual env, you will first need to install `GraphViz <http://graphviz.org/>`_
On a Mac, this can be done via ``brew install graphviz``; on Ubuntu, use ``sudo apt install graphviz``; on Red Hat variants use ``sudo dnf install graphviz``.
Next run the following commands::
Next, run the following commands

.. code-block:: bash
pip install sphinx # it may fail for non-obvious reasons without this
make requirements
Expand All @@ -64,7 +66,9 @@ Document isn't Included in any toctree

If you have some documents that you only reference via ``:doc:`` or ``:ref:`` tags you may get this error.
If there is no table of contents that the files obviously belong in, an easy way to fix this error is to put the
documents in a hidden toctree near where they are referenced::
documents in a hidden toctree near where they are referenced:

.. code-block:: rst
.. toctree::
:hidden:
Expand Down

0 comments on commit 69fd5da

Please sign in to comment.