Skip to content

Commit

Permalink
Merge pull request #131 from meghdadFar/chore/minor
Browse files Browse the repository at this point in the history
Chore
  • Loading branch information
meghdadFar authored Mar 25, 2024
2 parents d6812ed + 09cb599 commit aceb4e6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ instance/

# Sphinx documentation
# docs/build/
environment.pickle

# PyBuilder
target/
Expand Down
17 changes: 17 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.sphinx-doc.org/>`__ 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 <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
Expand Down

0 comments on commit aceb4e6

Please sign in to comment.