Use mkdocs for public documentation #2527
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
MattHag
force-pushed
the
create_mkdocs
branch
2 times, most recently
from
ac170a5 to
d834b7c
Compare
|
How can this be tested before merging? |
|
The resulting docs should be visible on my branch and could also be downloadable as artifact. |
|
Where is the analogue of https://pwr-solaar.github.io/Sofixlaar/capabilities |
Build and debug docs locally: mkdocs serve
- Remove ToDos from public docs
|
Here they are |
pfps
approved these changes
Jul 1, 2024
|
There are still some deployments via GitHub Actions triggered with a wrong theme, which overwrites the public Solaar documentation. |
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.
Build a better documentation with navigation that shows all pages, a search and includes developer documentation from Python code.
Fixes #2502, #2503