Please note: Friday June 18 is a holiday celebrating Juneteenth, please allow extra time for your order to arrive and plan accordingly.
0

Pre-commit and sphinx question
Moderators: adafruit_support_bill, adafruit

Please be positive and constructive with your questions and comments.

Pre-commit and sphinx question

by viennamike on Sat Apr 10, 2021 11:24 pm

I was having a heck of a time getting a pull request to pass checks, partly as I'm pretty new to the whole process. I had several problems, but towards the end, before I finally got it to pass all checks, it was made more difficult because when I ran pre-commit locally, it didn't run the sphinx checks that kept generating docstring format errors when testing the pull request on your github repository.

Is there something to install locally that would let these checks be run? Thanks!

viennamike
 
Posts: 22
Joined: Tue Feb 12, 2013 6:49 pm

Re: Pre-commit and sphinx question

by tannewt on Sun Apr 11, 2021 8:40 pm

Thanks for making a PR! The local sphinx instructions are here: https://learn.adafruit.com/creating-and ... eadthedocs

tannewt
 
Posts: 2428
Joined: Thu Oct 06, 2016 8:48 pm

Re: Pre-commit and sphinx question

by viennamike on Sun Apr 11, 2021 10:46 pm

Thanks!

viennamike
 
Posts: 22
Joined: Tue Feb 12, 2013 6:49 pm

Please be positive and constructive with your questions and comments.