From 69fd5da88b267bfa5f5568d3bee8415d10ba9a22 Mon Sep 17 00:00:00 2001 From: Emad Rad Date: Sat, 9 Nov 2024 11:47:59 +0330 Subject: [PATCH] chore: code block added for better readability --- README.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 3885f845..4fda0133 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ 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 @@ -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: