docs: minor errors - #1516
Merged
Merged
docs: minor errors#1516
Conversation
romain-dartigues
force-pushed
the
rdartigues/docs
branch
2 times, most recently
from
January 6, 2026 06:18
6388ae6 to
1dc8b5b
Compare
romain-dartigues
force-pushed
the
rdartigues/docs
branch
from
January 6, 2026 13:18
1dc8b5b to
0983395
Compare
Member
|
Thanks for fixing this up, @romain-dartigues!
Let's hold off on this for now, I'm weighing up moving away from sphinx to mkdocs/similar for simplicity so markdown is probably the future.
Autodocs output wasn't right for the pyinfra documentation (this is many years ago though, so I've long forgotten why :)), I know it can be tweaked but it'd be a similar effort to the current custom setup which works fine. I think unless there's a particular benefit to doing so the current system does the job well enough. |
Fizzadar
approved these changes
Jan 23, 2026
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.
I did fix a few errors in the documentation I came through today.
Quick questions:
pyinfra/docs/operations/opkg.rst:22: WARNING: Lexing literal_block 'opkg.packages(\n packages: str | typing.List[str]="", present: <class \'bool\'>=True,\n latest: <class \'bool\'>=False, update: <class \' bool\'>=True, **kwargs,\n)' as "python" resulted in an error at token: "'". Retrying in relaxed mode. [misc.highlighting_failure])