Skip to content

Commit

Permalink
Merge pull request #188 from punch-mission/187-fix-development-guide
Browse files Browse the repository at this point in the history
replace requirements_dev.txt in development guide
  • Loading branch information
jmbhughes authored Jun 24, 2024
2 parents 016c363 + a96870d commit 7f287fc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ We encourage all contributions. Please see our `contribution guide first <https:

We recommend working in a virtual environment.
This can be created by running ``python -m venv venv``. Then, activate the environment with ``source venv/bin/activate``.
You can then install the required packages with ``pip install -r requirements_dev.txt``.
You can then install the required packages with ``pip install ".[test]"``.

If at any time you run into issues, please contact us by :doc:`following the guidelines here <help>`.

Setting up pre-commit
----------------------

The first time you develop code, you'll need to install the pre-commit. This checks that our style is consistent.
It gets installed when you do ``pip install -r requirements_dev.txt`` but then requires you to activate them by
It gets installed when you do ``pip install ".[test]"`` but then requires you to activate them by
running ``pre-commit install``. Now everytime you commit, our checks will run first.

Building the docs
------------------
The docs are built using ``sphinx``. First, you must install it and the other documentation requirements with ::

pip install -r ./docs/requirements.txt
pip install -r requirements.txt
pip install ".[test]"
python setup.py build_ext --inplace

Then, navigate to the ``docs`` directory and run ``make html`` to build the docs.
Expand Down

0 comments on commit 7f287fc

Please sign in to comment.