Add Sphinx API Documentation - Githubissues

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 Sphinx API Documentation #10

Closed kiyou closed 2 years ago

kiyou commented 2 years ago

Summary

Add /docs dir and create sphinx files therein for API docs
Add GitHub Actions file for building API docs and deploying it to gh-pages branch for publishing through Github Pages
Modify .devcontainer to include sphinx and make packages simpler for testing

Purpose

Currently this project has no API documentation. This PR provides it by sphinx and GitHub Actions for deploying it through GitHub pages.

Change after merging

After merging this PR:

pushing to master or main branch will deploy documents to gh-pages branch.
pushing a tag will compile pdf documents and create a release with the compiled pdf as an asset.