Skip to content

Commit

Permalink
Build RTD docs from extras (#808)
Browse files Browse the repository at this point in the history
  • Loading branch information
Helveg committed Mar 5, 2024
1 parent b623f37 commit 03ed693
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 21 deletions.
11 changes: 4 additions & 7 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,13 @@ jobs:
uses: actions/setup-python@v1
with:
python-version: 3.9
- name: Install MPI
- name: Setup software environment
run: |
sudo apt update
sudo apt install -y openmpi-bin libopenmpi-dev
- name: Install dependencies
- name: Setup Python environment
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Install self
run: |
pip install -e .
- name: Fail documentations on warnings
pip install -e .[docs]
- name: Build documentation, nitpick, and fail on warnings
run: cd docs && sphinx-build -nW -b html . _build/html
3 changes: 2 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ python:
install:
- method: pip
path: .
- requirements: docs/requirements.txt
extra_requirements:
- docs
12 changes: 0 additions & 12 deletions docs/requirements.txt

This file was deleted.

4 changes: 3 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,9 @@ docs = [
"sphinxemoji~=0.2.0",
"sphinx_design~=0.5.0",
"sphinx-copybutton~=0.5.0",
"sphinxext-bsb~=0.2.1"
"sphinxext-bsb~=0.2.1",
"bsb-json>=0.0.0b5",
"bsb-yaml>=0.0.0b4",
]
dev = [
"build~=1.0",
Expand Down

0 comments on commit 03ed693

Please sign in to comment.