fix: pydata theme for documentation #48
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Adds pydata theme, same config as for the landing page * Restructured folders to have shorter names * Modifies Sphinx-Needs layout and representation * Minor layout fixes Issue-ref: resolves eclipse-score#42
4 tasks
qor-lb
approved these changes
Dec 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements the same Sphinx theming as for the SCORE landing page, see
eclipse-score/eclipse-score.github.io#3
Issue-ref: resolves #42
Change: Sphinx-Needs objects
Some options are now part of the object layout itself, and the metadata area is collapsed by default.
Additionally, all Sphinx-Needs got their own color, which highlights the line under the title.
Change: Folder structure
The Stakeholder and tool requirements got moved under a common "requirements" folder
Change: Folder rename
The long folder names like
process_documentation,stakeholder_requirementsgot shorten (including the related main page title).That was needed, as the theme is creating the navigation titles from it for the above nabvar, and the space there is limited.
Showcase
score_docs_showcase.mp4