PNNL-m-q / mzapy

A Python package that provides an interface to raw MS data in the MZA format.
BSD 2-Clause "Simplified" License
7 stars 1 forks source link

All Module reference sections in API reference part of docs should have subsections #17

Closed dylanhross closed 8 months ago

dylanhross commented 1 year ago

Some of the modules have subheads under "Module Reference" heading which looks nice on the main index page. For those that do not (e.g. the one with the MZA object) it just lists all the functions directly which doesnt look very nice. The best fix is to add subheadings under all of the "Module Reference" sections so that the main index page looks nice for all the modules. For the MZA object, it can be pretty easily divided into subheads for stuff like initilization/etc, functions for extracting data as DFs, functions for extracting data as arrays, and so on. For other modules, there is probably some way of categorizing the functions appropriately as well