diff --git a/docs/conf.py b/docs/conf.py index a684751..0549199 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,6 +31,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'nbsphinx', 'recommonmark', 'sphinx.ext.napoleon', 'sphinx.ext.autodoc', diff --git a/docs/index.rst b/docs/index.rst index c36f1ed..656d50d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,9 +5,16 @@ Introduction ------------ .. toctree:: :maxdepth: 1 - + README.md +Tutorial +-------- +.. toctree:: + :maxdepth: 1 + + tutorial.ipynb + Tips and Tricks --------------- .. toctree:: diff --git a/docs/tutorial.ipynb b/docs/tutorial.ipynb new file mode 120000 index 0000000..cafbea7 --- /dev/null +++ b/docs/tutorial.ipynb @@ -0,0 +1 @@ +../notebooks/tutorial.ipynb \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index b88034e..08aedd7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,2 +1,2 @@ [metadata] -description-file = README.md +description_file = README.md diff --git a/setup.py b/setup.py index dc51086..be5e75d 100644 --- a/setup.py +++ b/setup.py @@ -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', @@ -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',