IN-CORE / pyincore

pyIncore is a component of IN-CORE. It is a python package consisting of two primary components: 1) a set of service classes to interact with the IN-CORE web services, and 2) IN-CORE analyses . The pyIncore allows users to apply various hazards to infrastructure in selected areas, propagating the effect of physical infrastructure damage and loss of functionality to social and economic impacts.
Mozilla Public License 2.0
24 stars 7 forks source link

Some service class method documentation is not showing in the manual pages #518

Open navarroc opened 4 months ago

navarroc commented 4 months ago

There are many methods in the hazardservice.py and dataservice.py that look to have the right method documentation, but it is not showing in the generated HTML docs here: https://incore.ncsa.illinois.edu/doc/pyincore/modules.html#hazardservice.HazardService

We should investigate why the documentation isn't getting generated correctly and fix it. The DFR3Service has some methods showing in the docs, but not all: https://incore.ncsa.illinois.edu/doc/pyincore/modules.html#dfr3service.Dfr3Service