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

Documentation improvement #215

Open
gpengzhi opened this issue Sep 23, 2019 · 0 comments
Open

Documentation improvement #215

gpengzhi opened this issue Sep 23, 2019 · 0 comments
Labels
enhancement New feature or request topic: docs Issue about docstrings and documentation

Comments

@gpengzhi
Copy link
Collaborator

  1. Add CI test for building documentations (Do not ignore warnings and add spellcheck).
  2. Fix docstrings with incorrect/inconsistent Sphinx format. Currently, such issues are treated as warnings in the docs building.
@gpengzhi gpengzhi added enhancement New feature or request topic: docs Issue about docstrings and documentation labels Sep 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request topic: docs Issue about docstrings and documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gpengzhi