Skip to content

Commit

Permalink
Make the docs build actually run (#108)
Browse files Browse the repository at this point in the history
  • Loading branch information
wtbarnes authored Sep 11, 2024
1 parent dde4562 commit f1f2cdf
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ jobs:
python-version: '3.12'
libraries:
apt:
- graphviz
- libboost-all-dev
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The easiest way to install `ebtelplusplus` is through `pip`,
pip install ebtelplusplus
```

If you would like to compile and build the package from source, see [the instructions here](https://ebtelplusplus.readthedocs.org/latest/en/development.html).
If you would like to compile and build the package from source, see [the instructions here](https://ebtelplusplus.readthedocs.org/en/latest/development.html).

## Usage

Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@ docs = [
"sphinx-copybutton",
"sphinx-gallery",
"matplotlib",
# Need pkg_resources for sphinxcontrib-bibtex
# and this comes from setuptools
"setuptools",
]
dev = ["ebtelplusplus[test,docs]"]

Expand Down
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ set_env =

# Run the tests in a temporary directory to make sure that we don't import
# the package from the source tree
change_dir = .tmp/{envname}
changedir = .tmp/{envname}

deps =
oldestdeps: minimum_dependencies
Expand All @@ -54,7 +54,7 @@ commands_pre =
commands =
pytest --pyargs ebtelplusplus --cov ebtelplusplus --cov-report xml:coverage.xml --cov-report term-missing {posargs}

[testenv:build_docs]
[testenv:build_docs{,-gallery}]
changedir = docs
description = invoke sphinx-build to build the HTML docs
extras = docs
Expand Down

0 comments on commit f1f2cdf

Please sign in to comment.