Skip to content

Commit a8dcb9e

Browse files
authored
Auto list tutorials (#14)
* Auto list tutorials with glob * Fixed tutorials path * Execute tutorials * List tutorials with /* * FIxed parent * Build docs in action with make html * make html
1 parent 4e2f655 commit a8dcb9e

File tree

3 files changed

+4
-7
lines changed

3 files changed

+4
-7
lines changed

.github/actions/build-docs/action.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,4 @@ runs:
3333
shell: bash
3434
run: |
3535
cd docs
36-
if [ "${{ inputs.treat-warnings-as-errors }}" = "true" ]; then
37-
sphinx-build -b html -W --keep-going source build/html
38-
else
39-
sphinx-build -b html source build/html
40-
fi
36+
make html

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/.ipynb_checkpoints"]
5151

5252
# nbsphinx configuration
53-
nbsphinx_execute = "never" # Don't execute notebooks during build
53+
nbsphinx_execute = "always" # Execute notebooks during build
5454

5555

5656
# -- Options for HTML output -------------------------------------------------

docs/source/tutorials.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ Here are a few tutorials to help you get started.
55

66
.. toctree::
77
:maxdepth: 1
8+
:glob:
89

9-
tutorials/example_tutorial.ipynb
10+
tutorials/*

0 commit comments

Comments
 (0)