Merged
Conversation
854cf64 to
5ceb68f
Compare
potiuk
reviewed
Dec 18, 2023
potiuk
reviewed
Dec 18, 2023
docs/README.rst
Outdated
Member
There was a problem hiding this comment.
In the new version of build-docs (since ~ 3 months) you can simply specify package names as arguments without --package-filter - they are also autocomplete'able.
potiuk
reviewed
Dec 18, 2023
potiuk
reviewed
Dec 18, 2023
docs/README.rst
Outdated
Member
There was a problem hiding this comment.
You can add empty __init__.py and pre-commit should add the licence automatically as well.
potiuk
reviewed
Dec 18, 2023
Member
potiuk
left a comment
There was a problem hiding this comment.
Very nice! Thanks. There are a few NITs, and clarifications but it's great to see more guidelines for the contributors.
lzdanski
commented
Dec 20, 2023
josh-fell
reviewed
Dec 21, 2023
Contributor
josh-fell
left a comment
There was a problem hiding this comment.
This is tremendous! Only one question/suggestion.
Member
|
static checks :) |
5c2fb5e to
e54b887
Compare
potiuk
approved these changes
Dec 22, 2023
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.
After making a couple of my own docs PR's and helping some colleagues work with Sphinx, wanted to add some more detailed information to the Docs Readme that have commonly come up.
UNEXPECTED UNINDENTand resolution as well as the existing Sphinx bug that reports the incorrect line number.Other considerations: