Skip to content

Commit

Permalink
ci(docs): streamline documentation build process by using [docs] ex…
Browse files Browse the repository at this point in the history
…tra in pip install

docs(README): update instructions to include `[docs]` extra and add info about Read the Docs integration
  • Loading branch information
yxlao committed Dec 28, 2024
1 parent 7e4aa83 commit 25f5db3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx furo myst-parser
pip install -e .
pip install -e .[docs]
- name: Build documentation
run: |
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,9 @@ the beginning of the README.
To build and view the documentation locally:

```bash
# Install documentation dependencies
pip install -e .[docs]

# Build the documentation
cd docs
make clean && make html
Expand All @@ -269,6 +272,11 @@ python -m http.server 8000 --directory _build/html

Then open your browser and navigate to `http://localhost:8000` to view the documentation.

The documentation is also automatically built by GitHub Actions on pull requests and pushes to main. After merging to main, you can view:

- Public documentation at https://camtools.readthedocs.io/en/latest/
- Admin panel at https://app.readthedocs.org/projects/camtools/

## Contributing

- Follow [Angular's commit message convention](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format) for PRs.
Expand Down

0 comments on commit 25f5db3

Please sign in to comment.