Skip to content

Commit

Permalink
codacy
Browse files Browse the repository at this point in the history
  • Loading branch information
troyraen committed Jun 29, 2024
1 parent 6dcf8fe commit 6357182
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/source/main/for-developers/build-docs-sphinx.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# Build Documentation with Sphinx

This page describes how to build documentation locally for testing.
Our published documentation is built automatically when a [new version](release-new-version.md) is released.
Every PR triggers automatic testing of the documentation build, but you can't easily view the built documentation
This is not always needed.
Our published documentation is built and released automatically when a
[new package version](release-new-version.md) is released.
In addition, every PR triggers automatic testing of the documentation build.
However, those GitHub builds can take awhile and there doesn't seem to be an easy way to actually
view the built documentation.
For those reasons, it is sometimes helpful to be able to build the documentation locally.

1. Follow the setup steps in [Managing Dependencies with Poetry](manage-dependencies-poetry.md) to create a conda environment with Poetry installed. Then:
Follow the setup steps in [Managing Dependencies with Poetry](manage-dependencies-poetry.md) to
create a conda environment with Poetry installed. Then:

```bash
# Install pittgoogle dependencies, including those in the "docs" group.
poetry install --with=docs
```

2. Cd to the docs directory and run `make`:
Now, `cd` to the docs directory and run `make`:

```bash
cd docs # assuming we started in the repo root directory
Expand All @@ -22,5 +27,5 @@ make clean
make html
```

This created a file at `docs/build/html/index.html`.
Open it in a browser to view the documentation.
This should have created a file at `docs/build/html/index.html`.
Open it in a browser to view the built documentation.

0 comments on commit 6357182

Please sign in to comment.