Skip to content
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.

Sign up for GitHub

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

Integrating tutorial.ipynb into readthedocs #1163

Closed
wants to merge 16 commits into from
Closed

Integrating tutorial.ipynb into readthedocs #1163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
6b2d048
tutorial file in upynb format
GbotemiB Oct 10, 2022
7407174
Update GitHub Actions (#1134)
GbotemiB Oct 10, 2022
5ea0950
running notebook
GbotemiB Oct 10, 2022
919d17c
running notebook
GbotemiB Oct 10, 2022
af5463b
fix heading of tutorial file
GbotemiB Oct 11, 2022
0c464a7
corrections to header
GbotemiB Oct 11, 2022
b8bcc68
added numpydoc to extensions
GbotemiB Oct 11, 2022
0fd1ad0
markup fix
GbotemiB Oct 11, 2022
5559a01
fix markdown rendering
GbotemiB Oct 11, 2022
5113a99
fix markdown rendering
GbotemiB Oct 11, 2022
14f2c92
Merge branch 'main' into rst2sphinx
GbotemiB Oct 11, 2022
8750c71
Merge branch 'main' into rst2sphinx
joshmoore Oct 11, 2022
d24e5bc
Merge branch 'main' into rst2sphinx
GbotemiB Oct 12, 2022
7641814
recent changes
GbotemiB Oct 12, 2022
87a997f
Merge branch 'main' into rst2sphinx
GbotemiB Oct 12, 2022
5a166b8
Merge branch 'main' into rst2sphinx
GbotemiB Oct 13, 2022
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
7 changes: 7 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'nbsphinx',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.viewcode',
Expand All @@ -51,6 +52,12 @@
numpydoc_class_members_toctree = False
issues_github_path = 'zarr-developers/zarr-python'

nbsphinx_execute = 'auto'
nbsphinx_allow_errors = True

#Handling errors with rendering notebook
#nbsphinx_allow_errors = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Contents
:maxdepth: 2

installation
tutorial
tutorial_nb.ipynb
api
spec
contributing
Expand Down
Loading