python-can icon indicating copy to clipboard operation
python-can copied to clipboard

Fix Sphinx warnings

Open zariiii9003 opened this issue 2 years ago • 2 comments

I fixed all Sphinx warnings except for the nixnet interface, that one remains broken. The documentation is now built in github actions.

zariiii9003 avatar Oct 07 '22 18:10 zariiii9003

Codecov Report

Merging #1405 (7c7a092) into develop (89c395f) will increase coverage by 0.01%. The diff coverage is 87.50%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1405      +/-   ##
===========================================
+ Coverage    65.25%   65.27%   +0.01%     
===========================================
  Files           81       81              
  Lines         8767     8769       +2     
===========================================
+ Hits          5721     5724       +3     
+ Misses        3046     3045       -1     

codecov[bot] avatar Oct 07 '22 18:10 codecov[bot]

@hardbyte Can you check whether the readthedocs build works as configured in .readthedocs.yml? Or could you somehow add me to the rtd admins? Also: What do you think about the furo theme? It's the one that setuptools uses.

zariiii9003 avatar Oct 07 '22 18:10 zariiii9003

@zariiii9003 the furo theme looks great. I've invited you as an admin to python-can on readthedocs.

hardbyte avatar Oct 09 '22 20:10 hardbyte

I've invited you as an admin to python-can on readthedocs.

Thank you!

I will create another PR for furo.

zariiii9003 avatar Oct 09 '22 21:10 zariiii9003

@hardbyte Can you resync the rtd webhook? You can find it in Admin -> Integrations -> GitHub incoming webhook -> Resync webhook. New pull requests should trigger a rtd rebuild once it is synced.

I do not have the permissions to to do that.

zariiii9003 avatar Oct 13 '22 15:10 zariiii9003

Hmm resync didn't seem to work so I've deleted the webhook and added the read the docs integration from scratch. Thanks!

hardbyte avatar Nov 15 '22 20:11 hardbyte

Wow @zariiii9003 this PR is wonderful!

felixdivo avatar Nov 16 '22 08:11 felixdivo