search

geopython / GeoHealthCheck

Service Status and QoS Checker for OGC Web Services
https://geohealthcheck.org
MIT License
83 stars 71 forks source link

Doc updates for new ReadTheDocs requirements #467

Open justb4 opened 9 months ago

justb4 commented 9 months ago

Is your feature request related to a problem? Please describe. RTD has some new policies, and also the API docs (Python module APIs) are not rendered by RTD. Webhook seems broken. Can only be tested/verified by direct push on master.

Describe the solution you'd like Add a requirements.txt for docs and update .readthedocs.yaml

Describe alternatives you've considered Not really

Additional context N.A.

justb4 commented 4 months ago

API docs generated in https://docs.geohealthcheck.org/en/latest/autoapi/ but in plugins.rst automodule does not work. Should we fix or just link to autoapi sections?

Plugins - Base Classes
......................

These are the base classes for GHC Plugins. Developers will
mainly extend `Probe` and `Check`.

.. automodule:: GeoHealthCheck.plugin
   :members:
   :show-inheritance: