Skip to content

fix docs and add docs test in ci #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
import os
import bluepyefe

from pkg_resources import get_distribution

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand Down Expand Up @@ -57,9 +59,9 @@
#

# The short X.Y version.
version = bluepyefe.__version__
version = get_distribution("bluepyefe").version
# The full version, including alpha/beta/rc tags.
release = bluepyefe.__version__
release = version

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
10 changes: 6 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
[tox]
envlist = py3-{functional,style,syntax}
envlist =
py3-{functional,style,syntax}
docs
minversion = 4

[gh-actions]
python =
3.9: py3
3.10: py3
3.11: py3
3.12: py3
3.12: py3, docs

[testenv]
envdir =
py3{8,9,10,11,}{-functional,-notebooks,-style,-syntax}: {toxworkdir}/py3
py3{9,10,11,12,}{-functional,-notebooks,-style,-syntax}: {toxworkdir}/py3
docs: {toxworkdir}/docs
usedevelop = true
deps =
Expand All @@ -37,10 +39,10 @@ commands =
notebooks: pytest -n=auto --nbmake "examples"

[testenv:docs]
basepython = python3.9
changedir = docs
deps =
sphinx
sphinx-bluebrain-theme
setuptools
commands = make html SPHINXOPTS=-W
allowlist_externals = make