Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc updates for new ReadTheDocs requirements #467

Open
justb4 opened this issue Nov 19, 2023 · 1 comment
Open

Doc updates for new ReadTheDocs requirements #467

justb4 opened this issue Nov 19, 2023 · 1 comment
Assignees
Milestone

Comments

@justb4
Copy link
Member

justb4 commented Nov 19, 2023

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
Copy link
Member Author

justb4 commented Apr 9, 2024

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant