search

solo-spice / sospice

Python data analysis tools for the SPICE extreme-UV spectrometer on Solar Orbiter
BSD 3-Clause "New" or "Revised" License
12 stars 5 forks source link

Better generated API documentation #8

Open ebuchlin opened 1 year ago

ebuchlin commented 1 year ago

Sphinx is configured, but the generated API documentation is missing links between modules and submodules.

As a result, the pages for the submodules are not directly accessible from the main documentation page (although they exist).

ebuchlin commented 1 year ago

Tried to use this module documentation template in 2d8e6559d4832d69913391de84f0d0ff9d1397cd, doesn´t help much.

ebuchlin commented 1 year ago

See current online output on Read the Docs, issue is still present: class members not properly described. Also missing cross-references from package user manual (calibration.rst, catalog.rst...)

ebuchlin commented 7 months ago

Maybe merging with the output of the SunPy cookiecutter template could help.