Publish documentation to GitHub Pages #1774
Merged
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.
This makes it so release tags or any tag starting with
publish-docs
(for manual triggers if needed) will publish the documentation for the latest release on PyPI to GitHub Pages. Docs are also decompiled on pushes to master but not published just in case any errors eventually arise.After the potential merge and manual trigger, you'd then go to https://github.com/mhammond/pywin32/settings/pages and choose the
gh-pages
branch in the dropdown. At that point you're all done and the docs will be available for viewing for free at https://mhammond.github.io/pywin32/.Notes:
For some reason unlike my other sites, omitting the trailing slash at the end of the URL will not automatically redirect, so you may want to document it as https://mhammond.github.io/pywin32/index.html.fixed