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

docs: enable automatic documentation #35

Open
UrbanoFonseca opened this issue Sep 22, 2021 · 0 comments · May be fixed by #18
Open

docs: enable automatic documentation #35

UrbanoFonseca opened this issue Sep 22, 2021 · 0 comments · May be fixed by #18
Assignees
@UrbanoFonseca
Labels
feature A new feature

Comments

@UrbanoFonseca
Copy link
Contributor

UrbanoFonseca commented Sep 22, 2021 •
edited
Loading

Description of the feature

Implement a docstring parser that generates a readthedocs website to leverage documentation already developed.

Features

  • Automatic documentation of docstrings
  • Adhoc documentation of rst files
  • Custom CSS formatting by defining the /docs/_static/css/custom.css file
@UrbanoFonseca UrbanoFonseca added the feature A new feature label Sep 22, 2021
@UrbanoFonseca UrbanoFonseca self-assigned this Sep 22, 2021
@UrbanoFonseca UrbanoFonseca linked a pull request Sep 22, 2021 that will close this issue
chore(docs): setup automatic documentation #18
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@UrbanoFonseca UrbanoFonseca

Labels
feature A new feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(docs): setup automatic documentation ydataai/ydata-quality
1 participant
@UrbanoFonseca