Add Sphinx-based docs including a markdown version of the vocabulary guidelines v2.0 #93
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
Changes all gh-actions files to use hash-based identifiers for the used external actions. Change from Python 3.11 to 3.12
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.
We use Sphinx with the Furo theme and the MyST parser. So contributors can use markdown (as here on GitHub) and don't have to know the older reST markup language.
The documentation looks already quite nice. Light and dark modes are supported. I have adjusted the main colors to match the colors in the logo. The dark logo version has a brighter blue to increase the contrast to the background.
ToDos before this PR is ready for merging:
Deferred to later PRs:
Closes #91