Adjust sphinx documentation to work with github pages
Opened this issue · 3 comments
Description
To make the most of the sphinx documentation in Dr Header we will need to make a few adjustments to make it work with github pages.
We could also at a github action to do this for us and run it as part of the release process
info here on how to do it : https://daler.github.io/sphinxdoc-test/includeme.html
There will be some fun uploading to gh-pages because of PAT code restrictions.
This covers it and provides an example config.
https://stackoverflow.com/questions/57827703/github-actions-no-ci-alternative
Some of the documentation includes the old urls from the jamez's github , this ticket will include updating them.
this work is in progress in https://github.com/Santandersecurityresearch/DrHeader/tree/auto-build-documentation