Skip to content

Commit

Permalink
Merge pull request #730 from asmacdo/add-doc-build-instructions
Browse files Browse the repository at this point in the history
Add documentation building instructions
  • Loading branch information
yarikoptic authored Jan 23, 2024
2 parents 81f0d2f + 3aa4b2d commit 31d4b97
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,18 @@ This is best accomplished via::
pip install -e .[all]


Documentation
-------------

To contribute to the documentation, we recommend building the docs
locally prior to submitting a patch.

To build the docs locally:

1. From the root of the heudiconv repository, `pip install -r docs/requirements.txt`
2. From the `docs/` directory, run `make html`


Additional Hints
----------------

Expand Down

0 comments on commit 31d4b97

Please sign in to comment.