search

aai-institute / lakefs-spec

An fsspec implementation for the lakeFS project.
http://lakefs-spec.org/
Apache License 2.0
37 stars 4 forks source link

Docs: Link to root-level modules in API docs #273

Closed AdrianoKF closed 3 months ago

AdrianoKF commented 3 months ago

This adds functionality to gen_api_ref_pages.py to extract the module docstrings for root-level modules in the package, and adds links to them to the index page of the API reference.

image

See also previous PR: #272

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.32%. Comparing base (a1d7119) to head (8d1b159).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #273 +/- ## ======================================= Coverage 94.32% 94.32% ======================================= Files 5 5 Lines 388 388 Branches 72 72 ======================================= Hits 366 366 Misses 13 13 Partials 9 9 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

nicholasjng commented 3 months ago

Once the visual confirmation is there for nnbench, we can go ahead with this.

If you feel super instructive, you can give a quick comment about how __init__.pys contain submodule docstrings (i.e. collections of .py files under its tree) as opposed to normal .py files, but I'm happy either way.