Uh oh!
There was an error while loading. Please reload this page.
Add more info to Docs README - #36287
Conversation
854cf64 to
5ceb68fCompareUh oh!
There was an error while loading. Please reload this page.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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.
Very nice! Thanks. There are a few NITs, and clarifications but it's great to see more guidelines for the contributors.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
josh-fell
left a comment
There was a problem hiding this comment.
This is tremendous! Only one question/suggestion.
Uh oh!
There was an error while loading. Please reload this page.
potiuk
commented
Dec 22, 2023
static checks :) |
5c2fb5e to
e54b887Compare
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: