search

rom-py / rompy

Relocatable Ocean Modelling in PYthon (rompy) combines templated cookie-cutter model configuration with various xarray extensions to assist in the setup and evaluation of coastal ocean model
https://rom-py.github.io/rompy/
BSD 3-Clause "New" or "Revised" License
2 stars 9 forks source link

Make subclasses inherit fields from parents in the docs #35

Open rafa-guedes opened 10 months ago

rafa-guedes commented 10 months ago

The fields from a parent class are currently not defined in the docs of a subclass. Investigate if there is some sphinx config to allow for these to be shown.

rafa-guedes commented 9 months ago

This is now fixed in the api section of the docs by adding the :inherited-members: BaseModel argument to the .. automodule:: directives. However in other parts of the docs which use the .. autosummary:: directive this is still a problem.