docs generation script

[Bartolo1024]

I had some issues because in separated gh-branch option, files have to be in main directory and I don't know how to distinguish it from other non-git files in directory stage it automatically. Now script only delete specified outputs, inputs directories and HTML files and stage new versions after that.

I have set up it with this tutorial.

Before generation you have to make empty gh-actions branch:

git symbolic-ref HEAD refs/heads/gh-pages
rm .git/index
git clean -fdx
git add .
git commit -a -m "First pages commit"
git push origin gh-pages

There you can watch generated docs from my forked repo: my-results

[stared]

The result looks nice (except for processing docstrings - maybe there is some preferred style for params?).

For pushing dir, in JavaScript, there is https://www.npmjs.com/package/push-dir, which I use a lot.

For our current setup, search for "deploy Python documentation to GitHub pages" - I am sure there are some examples (it might be great to delegate it to GitHub Actions, instead of doing it manually).

[stared]

See:

• https://github.com/peaceiris/actions-gh-pages looks simpler
• https://github.com/marketplace/actions/deploy-to-github-pages-python