Closed chrisimcevoy closed 1 month ago
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.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
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.
That modules.rst was a table of contents of python packages, of which there is only one (pyoda_time).
From there you could finally click into the api docs for the package...
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:
pyoda_time.html: