re-add dollar signs to make formating of rst files nice

yoctoyotta1024 · Feb 27, 2024 · 60a7a91 · 60a7a91
1 parent 7a66d41
commit 60a7a91
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/source/usage/getstart.rst b/docs/source/usage/getstart.rst
@@ -7,12 +7,12 @@ Clone GoodSciProjTemplate's GitHub repository:
 
 .. code-block:: console
 
-  git clone https://github.com/yoctoyotta1024/GoodSciProjTemplate.git
+  $ git clone https://github.com/yoctoyotta1024/GoodSciProjTemplate.git
 
 and install the pre-commit hooks:
 .. code-block:: console
-
-  pre-commit install
+  
+  $ pre-commit install
 
 That's it, you're done! But maybe now you want to customise the project
 and push it to your own GitHub repo...

diff --git a/docs/source/usage/ourdocs.rst b/docs/source/usage/ourdocs.rst
@@ -9,14 +9,14 @@ followed by the Sphinx .html files, e.g.
 
 .. code-block:: console
 
-  cd ./docs && mkdir build && mkdir build/doxygen
-  doxygen doxygen/doxygen.dox && make html
+  $ cd ./docs && mkdir build && mkdir build/doxygen
+  $ doxygen doxygen/doxygen.dox && make html
 
 which you can then view in your preferred browser e.g.
 
 .. code-block:: console
 
-  open build/html/index.htm
+  $ open build/html/index.html
 
 Sphinx
 ######