Skip to content

Commit

Permalink
Use environmental variable to set multi version sphinx tag list (#390)
Browse files Browse the repository at this point in the history
  • Loading branch information
rob-luke authored Sep 23, 2021
1 parent 13d5695 commit f4efa16
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/SphinxBuild_PR.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "docs"
name: "PR Docs"
on:
- pull_request

Expand All @@ -20,6 +20,7 @@ jobs:
PYTHONUNBUFFERED: '1'
PYTHON_VERSION: '3.9'
MNE_3D_BACKEND: 'pyvistaqt'
SMV_TAG_WHITELIST: 'ignore all tags'
steps:
- uses: actions/checkout@v2
with:
Expand Down
5 changes: 4 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
from mne.tests.test_docstring_parameters import error_ignores


smv_tag_whitelist = os.getenv('SMV_TAG_WHITELIST', r'^v\d+\.\d+.\d+$')


# 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,7 +60,7 @@
# smv_tag_whitelist = r'^v\d+\.\d+.\d+$'
# They say to set this to None, but then Sphinx complains about it not being
# a string, so let's just use a regex that should lead to no tags
smv_tag_whitelist = 'ignore all tags'
# smv_tag_whitelist = 'ignore all tags'
# Mark vX.Y.Z as releases
smv_released_pattern = r'^.*v.*$'

Expand Down

0 comments on commit f4efa16

Please sign in to comment.