Skip to content

Commit

Permalink
add readme me doc
Browse files Browse the repository at this point in the history
  • Loading branch information
SamGuay committed Jul 24, 2024
1 parent e9da2c5 commit e49b9fa
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs_helper/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# How to build the doc locally

The GHA workflow is set to build the documentation and has more steps than
the usual `mkdocs serve`. So if you want to see the documentation locally,
you can use the following steps:

1. Create a virtual environment and install the dependencies in `requirements-docs.txt` with python 3.11.
2. Install dcm2bids within the virtual environment.
3. Run `dcm2bids -h > docs_helper/help.txt && dcm2bids_helper -h > docs_helper/helper.txt && dcm2bids_scaffold -h > docs_helper/help_scaffold.txt`
4. Run `mkdocs serve` to see the documentation locally.

Note that this will only run the latest local version of the documentation. `mike` takes care of the versioning through the GHA workflow.

0 comments on commit e49b9fa

Please sign in to comment.