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

Multiversionned docs #216

Merged
merged 2 commits into from
Dec 16, 2024

Conversation

minijackson
Copy link
Collaborator

This PR changes the way we build the documentation.

Instead of only building the documentation of master, it builds the documentation of master and nixos-24.05, and pushes both, respectively in the dev and nixos-24.05 directory.

This means that URLs will change. For example, the URL:

https://epics-extensions.github.io/EPNix/nixos-services/index.html
becomes
https://epics-extensions.github.io/EPNix/dev/nixos-services/index.html
or
https://epics-extensions.github.io/EPNix/nixos-24.05/nixos-services/index.html

But this also means that URLs will be less likely to break in the future.

Note to self, after this PR is merged, I need to backport the commit docs: support multiple versions, but making sure the release variable is correct in docs/conf.py.

Copy link
Collaborator

@stephane-cea stephane-cea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@minijackson minijackson merged commit d80640a into epics-extensions:master Dec 16, 2024
4 checks passed
@minijackson minijackson deleted the docs-multiversion branch December 16, 2024 11:54
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.

2 participants