Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust sphinx documentation to work with github pages #23

Open
amias-channer opened this issue Sep 17, 2019 · 3 comments
Open

Adjust sphinx documentation to work with github pages #23

amias-channer opened this issue Sep 17, 2019 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@amias-channer
Copy link
Contributor

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

@amias-channer amias-channer added the enhancement New feature or request label Sep 17, 2019
@amias-channer amias-channer self-assigned this Sep 17, 2019
@amias-channer
Copy link
Contributor Author

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

@amias-channer
Copy link
Contributor Author

Some of the documentation includes the old urls from the jamez's github , this ticket will include updating them.

@amias-channer
Copy link
Contributor Author

@amias-channer amias-channer added the documentation Improvements or additions to documentation label Sep 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants