Skip to content

Commit

Permalink
adds jupyter notebook tutorial to readthedocs; fixes #49
Browse files Browse the repository at this point in the history
  • Loading branch information
thurber committed Jun 14, 2021
1 parent d640319 commit 72c292a
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'nbsphinx',
'recommonmark',
'sphinx.ext.napoleon',
'sphinx.ext.autodoc',
Expand Down
9 changes: 8 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,16 @@ Introduction
------------
.. toctree::
:maxdepth: 1

README.md

Tutorial
--------
.. toctree::
:maxdepth: 1

tutorial.ipynb

Tips and Tricks
---------------
.. toctree::
Expand Down
1 change: 1 addition & 0 deletions docs/tutorial.ipynb
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[metadata]
description-file = README.md
description_file = README.md
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ def readme():

setup(
name='mosartwmpy',
version='0.0.6',
version='0.0.7',
packages=find_packages(),
url='https://github.com/IMMM-SFA/mosartwmpy',
license='BSD2-Simplified',
Expand Down Expand Up @@ -42,6 +42,7 @@ def readme():
extras_require={
'dev': [
'build==0.4.0',
'nbsphinx==0.8.6',
'recommonmark==0.7.1',
'setuptools==54.1.2',
'sphinx==3.5.2',
Expand Down

0 comments on commit 72c292a

Please sign in to comment.