-
Notifications
You must be signed in to change notification settings - Fork 116
doc: Use autodoc #466
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
doc: Use autodoc #466
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #466 +/- ##
========================================
Coverage 73.30% 73.30%
========================================
Files 26 26
Lines 8068 8068
Branches 1691 1696 +5
========================================
Hits 5914 5914
Misses 1627 1627
Partials 527 527
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1354c96
to
9d7c37d
Compare
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
9d7c37d
to
dd8f3b5
Compare
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
dd8f3b5
to
54d44cd
Compare
Signed-off-by: Cristian Le <git@lecris.dev>
Signed-off-by: Cristian Le <git@lecris.dev>
Signed-off-by: Cristian Le <git@lecris.dev>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM for generated docs
Where |
That will be a setting in # Do not build spglib C library on documentation builders
[[tool.scikit-build.overrides]]
if.any.env.READTHEDOCS = true
if.any.env.BUILD_DOCS = true
wheel.cmake = false If you add that it already works, but the sphinx builder will fail at build step. I'll see if this is a feature that would be added to
Footnotes |
Trying to revisit #420
In principle we can use
autodoc_type_aliases
to simplify the documentation