[WIP] Deployment of HTML documentation on alternative webhost #105
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Commit adds a tentative deployment to a github.io page which does not exist at the current moment through means of a github actions. The YML specification is relatively simple. The only manual component is that the sphinx version is specified "hard-coded" within the action file to ensure that the requirements can then be fully installed dynamically.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[WIP] Please do not merge
Rumor has it that your online deployment of your documentation seems to break from time to time. I am not exactly familiar with the way readthedocs works as a hosting service, but I am not sure you actually need to go through an alternative online platform to deploy your documentation. I am highly unaware of your field, so if having a readthedocs hosted documentation is a valuable thing for you, forget what I said.
This tentative PR uses a GitHub Actions to generate your webpage. It automatically setups sphinx with your requirement in a CI instance and deploys it automatically on a self-hosted github.io webpage which you would need to create. There is still some slight work required left to do on your side to enable such a github.io webpage, but as far as I remember, it is not a very daunting task.
If you need any help, just ping me. If you find that this solution is not exactly fitting to your specific needs, feel free to close the PR. Ping me if you need additional information.
We use a similar mechanism and the pipeline is pretty much the same https://lethe-cfd.github.io/lethe/index.html
Cheers
BB