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

On the version selector for the documentation #37559

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

janmenjayap
Copy link
Contributor

This PR includes the code for the version selector for the documentation.

Added a new HTML code to display the Version: #
Added the relevant versions in doc/en/website/conf.py.

This PR introduces the flexibility to switch between multiple versions in the documentation.

Fixes #37384.

πŸ“ Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes. (Not required it seems.)
  • I have updated the documentation accordingly. (Not required it seems.)

βŒ› Dependencies

None

@janmenjayap
Copy link
Contributor Author

Hello.
I have some questions.

  1. How to know the version of the documentation that is currently opened (for e.g. -- 'current_version': "10.2", but instead of 10.2 it can be 10.3-beta or any local version; how to check that)?
  2. Do I need to creat a separate versions.html file or changes in home.html is fair enough?
  3. Do I need to change any other conf.py file including these versions?

It will be absolutely helpful if these questions are answered.

Thank you :-)

@mkoeppe
Copy link
Member

mkoeppe commented Mar 10, 2024

I've merged the current development version to trigger the build of the documentation in the CI.

@mkoeppe
Copy link
Member

mkoeppe commented Mar 10, 2024

  1. How to know the version of the documentation that is currently opened (for e.g. -- 'current_version': "10.2", but instead of 10.2 it can be 10.3-beta or any local version; how to check that)?

The Sphinx configuration in src/sage_docbuild/conf.py obtains this version information from sage.version.version

Copy link

github-actions bot commented Mar 11, 2024

Documentation preview for this PR (built with commit 3fcc286; changes) is ready! πŸŽ‰
This preview will update shortly after each push to this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Version selector for the documentation
2 participants