HEPData / hepdata_lib

Library for getting your data into HEPData

https://hepdata-lib.readthedocs.io

MIT License

15 stars 39 forks source link

Add sphinx autosummary extension #210

Closed clelange closed 11 months ago

clelange commented 1 year ago

Fixes https://github.com/HEPData/hepdata_lib/issues/138 and supersedes https://github.com/HEPData/hepdata_lib/pull/152 (at least that's what I'm trying based on https://www.sphinx-doc.org/en/master/tutorial/automatic-doc-generation.html) - 2nd attempt

:books: Documentation preview :books:: https://hepdata-lib--210.org.readthedocs.build/en/210/

codecov-commenter commented 1 year ago

Codecov Report

Merging #210 (12536e1) into master (74b90d8) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #210   +/-   ##
=======================================
  Coverage   87.75%   87.75%           
=======================================
  Files           4        4           
  Lines         964      964           
  Branches      188      188           
=======================================
  Hits          846      846           
  Misses         86       86           
  Partials       32       32

Flag	Coverage Δ
unittests-3.8	`87.75% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

GraemeWatt commented 1 year ago

Thanks for continuing to maintain this vital software! We use Sphinx autosummary and Read the Docs to document the modules of the main hepdata repo. Looking at our configuration file (.readthedocs.yml) might help. I think you need to add - requirements: requirements.txt (see docs). I'd also recommend adding fail_on_warning: true. Settings from the Read the Docs web interface are ignored if using a .readthedocs.yml file. I can try to take a closer look at hepdata_lib if you get stuck. By the way, can you please add me (GraemeWatt) as a Maintainer for hepdata_lib from https://readthedocs.org/dashboard/ ?

clelange commented 1 year ago

Thanks @GraemeWatt - I'll give this a try, but will probably only get to this in two weeks or so, which is why I converted this PR into a draft. I'll first try to build things locally, so far I've tried to do this the lazy way with PRs only. You should have an invitation for readthedocs.

clelange commented 11 months ago

Not needed anymore