DM-53868: Switch to new sphinxutils + documenteer2 doc build#237
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #237 +/- ##
=======================================
Coverage 94.61% 94.61%
=======================================
Files 51 51
Lines 3883 3883
=======================================
Hits 3674 3674
Misses 209 209 ☔ View full report in Codecov by Sentry. |
Not directly needed by utils code but is easier if we do depend on it and we have agreed that lsst_distrib should include it.
a49c448 to
0a78729
Compare
TallJimbo
left a comment
TallJimbo
left a comment
There was a problem hiding this comment.
Changes seem fine, but they're not working for me locally; I get
$ package-docs build
Running Sphinx v8.1.3
Configuration error:
sphinx.show_github_edit_link is True by the project.github_url is not set.
I suspect "by" should be "but" in that error message.
I've tried setting show_github_edit_link = [Ff]alse in both conf.py and documenteer.toml to no avail.
| Parameters | ||
| ---------- | ||
| obj : function, method, or class | ||
| obj : `~collections.abc.Callable` |
There was a problem hiding this comment.
While it's an improvement in a lot of cases here, this new rigidity does make me sad (I like "convertible to ResourcePath" as a type, for example). Not much we can do about it, I imagine.
There was a problem hiding this comment.
I did add array-like to the ignore list because fixing all those seemed a step too far.
There was a problem hiding this comment.
If there's an ignore list we can add our own exceptions to then I'm totally happy with this change. I'm all for better guards against non-types due to mispellings, as long as we can carve out exceptions.
There was a problem hiding this comment.
Yes. It's in the documenteer.toml file.
2 participants
Requires lsst/sconsUtils#140
Checklist
doc/changes