From 09cb599b43af251b99392df752ae7a40377998e2 Mon Sep 17 00:00:00 2001 From: meghdadFar Date: Mon, 25 Mar 2024 14:12:37 +0100 Subject: [PATCH] Chore --- .gitignore | 1 + CONTRIBUTING.rst | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/.gitignore b/.gitignore index 07b65b5..6e9b3ce 100644 --- a/.gitignore +++ b/.gitignore @@ -70,6 +70,7 @@ instance/ # Sphinx documentation # docs/build/ +environment.pickle # PyBuilder target/ diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5748d76..71738ab 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -122,6 +122,23 @@ the instructions in `Pull Request (PR) <#pull-request-pr>`__. Note that you can skip pre-commit checks by running your ``git commit`` with the ``--no-verify`` flag (e.g. ``git commit -m 'dirty fix' --no-verify``), however, this is discouraged unless you really have to. + +Building the Documentation +---------------------------- +We use `Sphinx `__ to build the documentation. + +When you create new functions, write new docstring, or change the existing one, or in general change the documentation, you need to build the documentation again. To do so, run the following command: + + +.. code:: bash + + sphinx-build -b html sphinx-docs/source docs/ + +Also, ensure that the file `.nojekyll` always exists in the docs directory otherwise, the docs will not render correctly on GitHub Pages. + +This will build the documentation in the `docs `__ directory. You can now commit and push your changes to remote. + + Pull Request (PR) ----------------- Once your work is complete, you can make a pull request. Remember to