Add contributing links, add print version install verification

pybop-team · Dec 14, 2023 · 3ba9a6a · 3ba9a6a
1 parent 226670a
commit 3ba9a6a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 13 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -17,7 +17,7 @@ pip install -e .[all]
 ```
 ## Pre-commit checks
 
-Before you commit any code, please perform the following checks:
+Before you commit any code, please perform the following checks using [Nox](https://nox.thea.codes/en/stable/index.html):
 
 - [All tests pass](#testing): `$ nox -s unit`
 
@@ -128,7 +128,7 @@ This allows people to (1) use PyBOP without ever importing Matplotlib and (2) co
 
 ### Building documentation
 
-We use [Sphinx](http://www.sphinx-doc.org/en/stable/) to build our documentation. A nox session has been created to reduce the overhead when building the documentation locally. To run this session, type
+We use [Sphinx](http://www.sphinx-doc.org/en/stable/) to build our documentation. A [Nox](https://nox.thea.codes/en/stable/index.html) session has been created to reduce the overhead when building the documentation locally. To run this session, type
 
 ```bash
 nox -s docs

diff --git a/docs/conf.py b/docs/conf.py
@@ -73,12 +73,12 @@
     "navbar_align": "content",
     "navbar_center": ["navbar-nav", "version-switcher"],
     "show_version_warning_banner": True,
+    "footer_start": ["copyright"],
+    "footer_center": ["sphinx-version"],
     "switcher": {
         "json_url": json_url,
         "version_match": version_match,
     },
-    "footer_start": ["copyright"],
-    "footer_center": ["sphinx-version"],
 }
 
 html_static_path = ["_static"]

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -12,13 +12,13 @@ The simplest method to install PyBOP is using pip. Run the following command in
 
 .. code-block:: console
 
-    $ pip install pybop
+    pip install pybop
 
 This command will download and install the latest stable version of PyBOP. If you want to install a specific version, you can specify the version number using the following command:
 
 .. code-block:: console
 
-    $ pip install pybop==23.11
+    pip install pybop==23.11
 
 Installing the Development Version
 ----------------------------------
@@ -27,7 +27,7 @@ If you're interested in the cutting-edge features and want to try out the latest
 
 .. code-block:: console
 
-    $ pip install git+https://github.com/pybop-team/PyBOP.git@develop
+    pip install git+https://github.com/pybop-team/PyBOP.git@develop
 
 Please note that the development version may be less stable than the official releases.
 
@@ -38,21 +38,24 @@ For those who prefer to install PyBOP from a local clone of the repository or wi
 
 .. code-block:: console
 
-    $ pip install -e "path/to/pybop"
+    pip install -e "path/to/pybop"
 
 In editable mode, changes you make to the source code will immediately affect the PyBOP installation without the need for reinstallation.
 
 Verifying Installation
 ----------------------
 
-To verify that PyBOP has been installed successfully, try running one of the provided example scripts included in the documentation or repository. If the example executes without any errors, PyBOP is ready to use.
+To verify that PyBOP has been installed successfully, try running one of the provided example scripts included in the documentation or repository. If the example executes without any errors, PyBOP is ready to use. Alternatively, you can run the following command in your terminal to check the version of PyBOP that is installed:
+
+.. code-block:: console
+
+    python -c "import pybop; print(pybop.__version__)"
+
 
 For Developers
 --------------
 
-If you are installing PyBOP for development purposes, such as contributing to the project, please ensure that you follow the guidelines outlined in the contributing guide. It includes additional steps that might be necessary for setting up a development environment, including the installation of dependencies and setup of pre-commit hooks.
-
-`Contributing Guide <../Contributing.html>`_
+If you are installing PyBOP for development purposes, such as contributing to the project, please ensure that you follow the guidelines outlined in the `Contributing Guide <../Contributing.html>`_. It includes additional steps that might be necessary for setting up a development environment, including the installation of dependencies and setup of pre-commit hooks.
 
 Further Assistance
 ------------------

diff --git a/docs/quick_start.rst b/docs/quick_start.rst
@@ -14,7 +14,7 @@ To begin using PyBOP:
 
    .. code-block:: console
 
-       $ pip install pybop
+       pip install pybop
 
    For detailed installation instructions, including how to install specific versions or from source, see the :ref:`installation` section.