Skip to content

Commit

Permalink
Update pkg install in docs contribution guide (#304)
Browse files Browse the repository at this point in the history
* Update pkg install in docs contribution guide

Changed the command to install the project for docs development to use
`python -m pip`. This ensures that the Python interpreter from the
activated environment is used when installing the package in editable
mode.

* Add PR#304 to docs section of v1.1.1 Release Notes
  • Loading branch information
douglatornell authored Nov 18, 2024
1 parent 09e4752 commit c7970e2
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Whilst the CI will build the updated documentation for each PR, it can also be u
```bash
mamba env create -f ci/doc.yml
mamba activate virtualizarr-docs
pip install -e . # From project's root - needed to generate API docs
python -m pip install -e . # From project's root - needed to generate API docs
cd docs # From project's root
rm -rf generated
make clean
Expand Down
2 changes: 2 additions & 0 deletions docs/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ Documentation
(:issue:`291`, :pull:`296`) By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Minor improvements to the Contributing Guide.
(:pull:`298`) By `Tom Nicholas <https://github.com/TomNicholas>`_.
- More minor improvements to the Contributing Guide.
(:pull:`304`) By `Doug Latornell <https://github.com/DougLatornell>`_.

Internal Changes
~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit c7970e2

Please sign in to comment.