chrisimcevoy / pyoda-time

A better date and time API for Python
https://pyodatime.org/
Apache License 2.0
1 stars 0 forks source link

docs: dont generate modules.rst #166

Closed chrisimcevoy closed 1 month ago

chrisimcevoy commented 1 month ago

I found the structure of the docs very confusing.

The confusing, old way

We had an index.rst that included modules.rst in its contents.

image

That modules.rst was a table of contents of python packages, of which there is only one (pyoda_time).

image

From there you could finally click into the api docs for the package...

image

The confusion arose from the use of the text "pyoda_time", with multiple, subtly different meanings in different contexts - even within the same html file.

The less confusing, new way

We tell sphinx-apidoc not to generate a table of contents file at all, so no more modules.rst.

We just link directly from the index.rst to the pyoda_time.rst, cutting out the middleman.

This is much less confusing.

index.html:

image

pyoda_time.html:

image

codecov[bot] commented 1 month ago

Codecov Report

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

Please upload report for BASE (main@bd92195). Learn more about missing BASE report.

:exclamation: Current head d929480 differs from pull request most recent head e9ef5d9

Please upload reports for the commit e9ef5d9 to get more accurate results.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #166 +/- ## ======================================= Coverage ? 95.47% ======================================= Files ? 257 Lines ? 19559 Branches ? 0 ======================================= Hits ? 18674 Misses ? 885 Partials ? 0 ```

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