GeoHealthCheck icon indicating copy to clipboard operation
GeoHealthCheck copied to clipboard

Doc updates for new ReadTheDocs requirements

Open justb4 opened this issue 2 years ago • 1 comments

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 avatar Nov 19 '23 12:11 justb4

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:

justb4 avatar Apr 09 '24 11:04 justb4