This PR loads jupyter notebooks in test_files directory into tutorial section in sphinx documentation by using nbsphinx and pandoc.
Purpose
Currently, users have to open *.ipynb files in test_files directory to see use our package.
It would be better for users to make it available in another formats by converting them into html and pdf documentation in terms of accessibility.
Change after merging
After merging this PR:
*.ipynb files in test_files directory are loaded and converted into newly created Tutorial section in Sphinx documentation.
Add sections and change section levels in jupyter notebook files.
Summary
This PR loads jupyter notebooks in
test_files
directory intotutorial
section in sphinx documentation by usingnbsphinx
andpandoc
.Purpose
Currently, users have to open
*.ipynb
files intest_files
directory to see use our package. It would be better for users to make it available in another formats by converting them into html and pdf documentation in terms of accessibility.Change after merging
After merging this PR:
*.ipynb
files intest_files
directory are loaded and converted into newly created Tutorial section in Sphinx documentation.