update sphinx documentation and GitHub Actions - 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

update sphinx documentation and GitHub Actions #13

Closed kiyou closed 2 years ago

kiyou commented 2 years ago

Summary

This PR will

fix bugs while building sphinx documents due to the previous removal of requirements.txt
change setup.cfg and read it for building sphinx documents
read version of module from __version__.py
fix GitHub actions and only create a release draft only when tags are pushed
add url variable to setup.cfg
change release asset name
fix a bug of GitHub Actions and deploy GitHub pages when pushing to master branch

Purpose

Currently, version info is not set and author information is not linked to setup.cfg.
The previous merging removed requirements.txt, which yields errors for building sphinx documents by GitHub Actions
The deployment to GitHub pages by GitHub Actions is currently activated for a push to main branch, which should be master branch

Change after merging

After merging this PR:

version information for sphinx documents will be obtained from interfacemaster.__version__.
author information is parsed from setup.py.
pushing to master branch will deploy API document page to gh-pages branch

jinlhr542 commented 2 years ago

Thank u!