From 3aa4b2d708c11597b77a4107d88d0e6e61c10d5c Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Fri, 12 Jan 2024 14:49:40 -0500 Subject: [PATCH] Add documentation building instructions --- CONTRIBUTING.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 88bef0bc..772b17f3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 ----------------