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.

Sign up for GitHub

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

Jump to bottom

Include deploying "latest release" documentation instead of only deploying the main #63

Open
arthurmloureiro opened this issue Nov 15, 2024 · 1 comment
Open

Include deploying "latest release" documentation instead of only deploying the main #63

arthurmloureiro opened this issue Nov 15, 2024 · 1 comment
Assignees
@arthurmloureiro
Labels
Docs 📄 Issues related with documentation Github-CI

Comments

@arthurmloureiro
Copy link
Contributor

Currently, our documentation deployment only deploys the documentation for the main branch and not the one in the latest release. This means that if the user installs the conda forge or PiPY version, the documentation will be outdates.

We need to include the documentation for the latest release together with the documentation for the main branch in the deployed documentation.
@arthurmloureiro arthurmloureiro added Docs 📄 Issues related with documentation Github-CI labels Nov 15, 2024
@arthurmloureiro arthurmloureiro self-assigned this Nov 15, 2024
arthurmloureiro added a commit that referenced this issue Nov 15, 2024
@arthurmloureiro
Include deploying latest release documentation
3d105b3 
Related to #63

Add deployment of latest release documentation along with the main branch.

* Update `.github/workflows/build_docs.yml` to include a new job `build-docs-release` that triggers on release events and deploys the latest release documentation to the `gh-pages` branch.
* Modify `docs/source/conf.py` to handle multiple versions of documentation by adding logic to differentiate between the main branch and the latest release, and updating `html_theme_options` to include a version selector.
* Update `README.md` to mention that the deployed documentation now includes the latest release along with the main branch.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/LSSTDESC/Smokescreen/issues/63?shareId=XXXX-XXXX-XXXX-XXXX).
@arthurmloureiro arthurmloureiro mentioned this issue Nov 15, 2024
Merged
@arthurmloureiro
Copy link
Contributor Author

⚠️ GH workspaces "fix" breaks so revert to the previous release before that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arthurmloureiro arthurmloureiro

Labels
Docs 📄 Issues related with documentation Github-CI
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@arthurmloureiro