Fix Sphinx errors/warnings & Misc. cleanups #347
Conversation
|
I honestly can't make much sense of the remaining Sphinx output, like this one. |
Codecov Report
@@ Coverage Diff @@
## develop #347 +/- ##
==========================================
Coverage ? 58.83%
==========================================
Files ? 54
Lines ? 4273
Branches ? 0
==========================================
Hits ? 2514
Misses ? 1759
Partials ? 0
Continue to review full report at Codecov.
|
|
Yeah I find it quite hard to track down what sphinx complains about. Most of those |
can/util.py
Outdated
| return config | ||
|
|
||
|
|
||
| def choose_socketcan_implementation(): |
There was a problem hiding this comment.
This shouldn't be in a doc update PR
There was a problem hiding this comment.
This branch that you created quite a while back was a few dozen commits behind develop, and this resulted from the rebase to resolve the conflicts. Was this wrong?
There was a problem hiding this comment.
Oh right I didn't notice you were starting with an older branch. Yes this was removed on purpose (in the socketCAN consolidation).
I suggest rebasing on top of develop - either force push over this branch or to another branch.
There was a problem hiding this comment.
If it helps I've rebased my original clean up commits on the current develop branch fix-sphinx-errors-rebase
There was a problem hiding this comment.
Uhm, I already applied other patches on top of the rebase. Wouldn't it be the simplest to just remove the choose_socketcan_implementation() function?
|
Should we ask for help over here: https://github.com/sphinx-doc/sphinx ? |
|
No I don't think there is a problem with sphinx. I think we just haven't been particularly careful with our docs. One additional thing though - we should check the heading levels make sense. In the 2.2.0 release we accidentally included this https://python-can.readthedocs.io/en/2.2.0/development.html#about-the-busabc-class |
|
Okay; I was rather supposing that we ask for how to get more helpful error statements out of Sphinx' build process. Well, was that section really an accident? It is in the Developer's section, which is the right place for that, isn't it? |
|
Sorry I should have been clearer - the section's content is fine, it is the heading level that is making it much more important than it should be:
|
|
Oh sure, that's not meant to be! |
|
Does not fix all problems, so #262 remains open. |
@hardbyte I'll fix some errors here based on the work you have already done a few months back, and notify you when I'm done.