@siavashk can you please go to the settings tab on the repository & enable GitHub Actions and GitHub Pages. This should enable the setup GitHub Actions to automatically compile the docs & publish on push to master. There might be some bugs in doing that, if there are I am happy to look into them.
Once this is complete, then we have all requirements for the manuscript submission to JOSS and I will make that submission.
If you pull this branch to your local computer you should be able to open .../pycpd/docs/pycpd/index.html in your browser to preview the documentation.
Makefile
to root directory that allows easy running of pre-specified commands (build
,doc
,test
, etc.)make
for multiple use casesMakefile
to automatically build docs to/docs
subfolderpdoc3
which is extremely straightforward:./github/workflows/docs.yml
that should auto compile docs on new push to master.@siavashk can you please go to the settings tab on the repository & enable GitHub Actions and GitHub Pages. This should enable the setup GitHub Actions to automatically compile the docs & publish on push to
master
. There might be some bugs in doing that, if there are I am happy to look into them.Once this is complete, then we have all requirements for the manuscript submission to JOSS and I will make that submission.
If you pull this branch to your local computer you should be able to open
.../pycpd/docs/pycpd/index.html
in your browser to preview the documentation.