nmdl-mizo / interface_master

A python package building CSL or approximate CSL interfaces of any two lattices and computing cell of non-identical displacement (CNID).
MIT License
12 stars 4 forks source link

Add tutorial section into sphinx documentation from jupyternotebook files #14

Closed kiyou closed 2 years ago

kiyou commented 2 years ago

Summary

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: