-
Notifications
You must be signed in to change notification settings - Fork 13
Migrate sphinx documentation system to material for mkdocs #48
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
base: develop
Are you sure you want to change the base?
Conversation
aebeb75 to
9b384de
Compare
jonathan343
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just had a couple of comments and suggestions. We should also include related changelog entries to each client so they're included in our next release.
| } | ||
|
|
||
| p:has(span.breadcrumb) { | ||
| margin-top: 0; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super nit / not blocking:
| margin-top: 0; | |
| margin-top: 0; |
We should indent this for all three clients
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed!
| uv venv --python $(PYTHON_VERSION) | ||
|
|
||
| docs-install: venv | ||
| uv sync --group docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These packages don't have lock files. We should be using uv pip instead of uv sync. This also prevents us from generating unwanted uv.lock files.
| uv sync --group docs | |
| uv pip install -e . --group docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That makes sense. I updates this and added the --no-sync flag to the uv run commands in the individual clients to avoid creating uv.lock files from there as well.
| - pymdownx.snippets: | ||
| check_paths: true | ||
| - pymdownx.superfences | ||
| - pymdownx.tabbed: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this here and not in the nested clients?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This enables content tabs in the "All Available Clients" page for the top-level documentation site. We don't need this plugin in the individual clients since we don't use content tabs anywhere.
With pymdownx.tabbed:
Without:
Description
This PR merges the
feat/migrate-sphinx-to-mkdocsfeature branch intodevelop, completing the migration from the existing Sphinx documentation system to Material for MkdocsRelated PRs in
feat/migrate-sphinx-to-mkdocs:In addition to the documentation migration, this PR:
developThis PR and the related code generator update will be merged simultaneously.
Testing
How to Generate Docs
For top-level client docs, execute these commands in the root level of this repo. For individual client documentation, execute these commands in each client's directory.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.