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

Sphinx Versioning #19

Merged
merged 2 commits into from
Dec 19, 2024
Merged

Sphinx Versioning #19

merged 2 commits into from
Dec 19, 2024

Conversation

Xeratec
Copy link
Collaborator

@Xeratec Xeratec commented Dec 19, 2024

Changelog

This merge request updates the Sphinx documentation and adds functionality to select the version. The different documentation version for different branches can be selected in the left sidebar.

You can view the documentation with the changes implemented at: Chimera SDK Documentation Example

Added

  • Functionality to extract the current Git branch name using git rev-parse --abbrev-ref HEAD.
  • Integration of the branch name into the Sphinx HTML templates for improved documentation versioning and clarity.

Changed

  • Updates to conf.py in the Sphinx documentation source to support dynamic branch name handling.

@Xeratec Xeratec added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 19, 2024
@Xeratec Xeratec requested a review from viv-eth December 19, 2024 08:59
@Xeratec Xeratec self-assigned this Dec 19, 2024
@viv-eth viv-eth merged commit 242aff7 into pulp-platform:devel Dec 19, 2024
4 checks passed
@Xeratec Xeratec deleted the pr/doc_versioning branch December 19, 2024 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants