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

Module level documentation #5

Open
alecgunny opened this issue Mar 22, 2022 · 0 comments
Open

Module level documentation #5

alecgunny opened this issue Mar 22, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@alecgunny
Copy link
Contributor

Include module level documentation that explains high-level concepts like Environments, Projects, and Pipelines, as well as class/method level documentation (though this is less important since I'm not sure this is mature enough for external use of the underlying Python code). Include this documentation in the docs build via Sphinx autodoc

@alecgunny alecgunny added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant