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.

Sign up for GitHub

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

Jump to bottom

Add auto documentation from docstring inside sphinx #110

Closed
Galileo-Galilei opened this issue Nov 1, 2020 · 0 comments
Closed

Add auto documentation from docstring inside sphinx #110

Galileo-Galilei opened this issue Nov 1, 2020 · 0 comments
Assignees
@Galileo-Galilei
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Release 0.7.3

Comments

@Galileo-Galilei
Copy link
Owner

Description

The current documentation is becoming more and more decorrelated from the actual code. In particular, the "Python objects" section is hard to maintain up to date.

Context

A better documentation will help user to use the package efficiently.

Possible Implementation

The autodoc extension of Sphinx can help by generating description from the docstrings.
@Galileo-Galilei Galileo-Galilei added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 1, 2020
@Galileo-Galilei Galileo-Galilei added this to the Release 0.6.0 milestone Jan 25, 2021
@Galileo-Galilei Galileo-Galilei modified the milestones: Release 0.7.1, 0.7.2 Apr 10, 2021
Galileo-Galilei added a commit that referenced this issue Sep 20, 2021
@Galileo-Galilei
📝 Use sphinx to automatically document the API with docstrings (#110)
f6a549a
@Galileo-Galilei Galileo-Galilei mentioned this issue Sep 20, 2021
Merged
6 tasks
Galileo-Galilei added a commit that referenced this issue Sep 20, 2021
@Galileo-Galilei
📝 Use sphinx to automatically document the API with docstrings (#110)
ee78a0f
Galileo-Galilei added a commit that referenced this issue Sep 20, 2021
@Galileo-Galilei
📝 Use sphinx to automatically document the API with docstrings (#110)
5bee880
@Galileo-Galilei Galileo-Galilei self-assigned this Nov 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Galileo-Galilei Galileo-Galilei

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
kedro-mlflow roadmap
Status: ✅ Done
Milestone
Release 0.7.3
Development

No branches or pull requests
1 participant
@Galileo-Galilei