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

Consider deploying sphinx for autodocs #286

Open
cmcginley-splunk opened this issue Sep 11, 2024 · 1 comment
Open

Consider deploying sphinx for autodocs #286

cmcginley-splunk opened this issue Sep 11, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@cmcginley-splunk
Copy link
Collaborator

Sphinx provides great utilities for auto-generating docs for code based on docstrings. We should consider utilizing it and publishing our docs using it. Note that to get the most out of it we would need to enforce reST style docstrings on all classes, modules, functions and class/instance attributes.

@cmcginley-splunk cmcginley-splunk added the enhancement New feature or request label Sep 11, 2024
@cmcginley-splunk
Copy link
Collaborator Author

cmcginley-splunk commented Sep 12, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant