-
-
Notifications
You must be signed in to change notification settings - Fork 583
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use only autodoc
to generate the API documentation
#1021
Conversation
Codecov ReportBase: 98.21% // Head: 98.21% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #1021 +/- ##
=======================================
Coverage 98.21% 98.21%
=======================================
Files 20 20
Lines 3529 3530 +1
Branches 537 537
=======================================
+ Hits 3466 3467 +1
Misses 47 47
Partials 16 16
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
I really have no idea how to fix this anymore. As far as I can see now, I don't think any additional typing can be included into the documentation without completely restructuring it. |
I can try to have a look in a bit, thanks for the efforts so far. |
* origin/main: Remove noise from the Sphinx config. Fix instantiating validators with cached refs-to-bool schemas. Try fixing more Sphinx refs which fail only on Ubuntu...
OK, the commit I just pushed I believe should move this forward. |
@Julian This looks perfect! Well done figuring this out, I wasn't able to... I'm fine with merging! |
check-docstring-first has to go unfortunately due to pre-commit/pre-commit-hooks#159.
As discussed in #1019
autoapi
has some issues with typing annotations.This creates almost parity with the current documentation. There are slight differences in lay-out and some additional classes get documented (they could be excluded by hand).
I tested this with the other PR and could build with
make html
without any validation errors. I'll rebase that PR on this one as a final test.📚 Documentation preview 📚: https://python-jsonschema--1021.org.readthedocs.build/en/1021/