Repository navigation
Docs: Sphinx on the shared documentation package - #45
Merged
Merged
Conversation
MyST Markdown, autodoc with Google-style docstrings, the shared top bar and theme, and the live demos carried across. A docs workflow builds the site with sphinx-build -W, as Read the Docs does. Docstring-only edits so the reference builds without warnings.
This file contains hidden or 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
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.
Moves the documentation from MkDocs Material to Sphinx, on the shared
pydevices-docspackage (PyDevices/.github,docs-config/, pinned to thedocs-v0.1.0tag): MyST Markdown, autodoc with Google-style docstrings, the shared top bar, and the live browser demos carried across as raw HTML.A new Docs workflow builds the site with
sphinx-build -Wfrom the repository root, the way Read the Docs does (fail_on_warning: true). The edits tolib/are docstrings only (a bare\nin three docstrings, a list without a blank line, a stray*).Read the Docs builds the
latestversion frommain, so the published site changes look when this merges.