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

Jump to bottom

[WIP] Add notebooks to docs #142

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[WIP] Add notebooks to docs #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0dbd1a0
Update conf.py
cchwala Nov 10, 2023
4ec10cb
trying to add one notebook to doc page
cchwala Nov 10, 2023
533a196
Update requirements_docs.txt
cchwala Nov 10, 2023
879c8f8
try other path for notebook
cchwala Nov 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/conf.py
View file
Open in desktop
Expand Up @@ -33,7 +33,8 @@
extensions = [
"sphinx.ext.autodoc",
'sphinx.ext.napoleon',
'm2r2'
'm2r2',
'nbsphinx',
]

napoleon_google_docstring = False
Expand Down
7 changes: 6 additions & 1 deletion docs/index.rst
View file
Open in desktop
Expand Up @@ -25,11 +25,16 @@ Usage

.. toctree::
:maxdepth: 1
:hidden:
:caption: User Guide

API <source/pycomlink>

.. toctree::
:maxdepth: 1
:caption: Examples

../notebooks/Basic CML processing workflow

.. toctree::
:maxdepth: 1
:hidden:
Expand Down
1 change: 1 addition & 0 deletions docs/requirements_docs.txt
View file
Open in desktop
Expand Up @@ -3,3 +3,4 @@ sphinx
sphinx-autobuild
sphinx_rtd_theme
m2r2
nbsphinx