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

deploy documentation to static sites #83

Merged
merged 17 commits into from
Nov 26, 2024
Merged

deploy documentation to static sites #83

merged 17 commits into from
Nov 26, 2024

Conversation

shapiromatron
Copy link
Collaborator

@shapiromatron shapiromatron commented Nov 26, 2024

Through trial and error, deploy pybmds documentation to two locations:

  1. https://usepa.github.io/BMDS/. This shows documentation for the latest tagged (released) version and is appealing as it has the U.S. EPA GitHub subdomain as part of the URL. This is triggered automatically whenever a tag is applied to the git repository.
  2. https://pybmds.readthedocs.io/. This shows documentation for current and prior tagged versions, so it may be useful for people working with older versions of the software. This capability is not available using the github.io subdomain without significant effort. This is triggered manually.

In addition, added assorted badges to home page of the GitHub readme for the BMDS repository, now that documentation is available.

@shapiromatron shapiromatron marked this pull request as ready for review November 26, 2024 19:48
@shapiromatron shapiromatron changed the title documentation deployment deploy documentation to static sites Nov 26, 2024
@shapiromatron shapiromatron merged commit 0f232a5 into main Nov 26, 2024
2 checks passed
@shapiromatron shapiromatron deleted the deploy-docs branch November 26, 2024 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant