search

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 #209

Closed clelange closed 1 year ago

clelange commented 1 year ago

Fixes #138 and supersedes #152 (at least that's what I'm trying based on https://www.sphinx-doc.org/en/master/tutorial/automatic-doc-generation.html)

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

codecov-commenter commented 1 year ago

Codecov Report

Merging #209 (49bc018) into master (74b90d8) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #209   +/-   ##
=======================================
  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.

clelange commented 1 year ago

Still doesn't seem to fix the issue, but I'm getting some warnings now:

Creating a new release automatically via an issue
-----------------------------
WARNING: autodoc: failed to import module 'hepdata_lib'; the following exception was raised:
No module named 'numpy'
WARNING: autodoc: failed to import module 'root_utils' from module 'hepdata_lib'; the following exception was raised:
No module named 'numpy'
/home/docs/checkouts/readthedocs.org/user_builds/hepdata-lib/checkouts/209/docs/source/modules.rst:4: WARNING: autosummary: failed to import hepdata_lib.
Possible hints:
* ModuleNotFoundError: No module named 'numpy'
* KeyError: 'hepdata_lib'
* ValueError: not enough values to unpack (expected 2, got 1)
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/hepdata-lib/checkouts/209/docs/source/hepdata_lib.rst: WARNING: document isn't included in any toctree
done

--> Need to fix the import path

clelange commented 1 year ago

Preview picks up wrong requirements.txt now (had changed this in the readthedocs settings). Closing and will reopen.