-
Notifications
You must be signed in to change notification settings - Fork 16.4k
Add more info to Docs README #36287
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
Add more info to Docs README #36287
Conversation
854cf64 to
5ceb68f
Compare
docs/README.rst
Outdated
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.
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.
docs/README.rst
Outdated
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.
You can add empty __init__.py and pre-commit should add the licence automatically as well.
potiuk
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.
Very nice! Thanks. There are a few NITs, and clarifications but it's great to see more guidelines for the contributors.
josh-fell
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.
This is tremendous! Only one question/suggestion.
|
static checks :) |
5c2fb5e to
e54b887
Compare
josh-fell
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.
🚀
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: