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

Prepare project for generating documentation using sphinx #13

Closed
pylipp opened this issue Oct 10, 2019 · 2 comments
Closed

Prepare project for generating documentation using sphinx #13

pylipp opened this issue Oct 10, 2019 · 2 comments
Labels
documentation enhancement good first issue

Comments

@pylipp
Copy link
Owner

pylipp commented Oct 10, 2019

  • set up sphinx stack (update setup.py and Makefile; also gitignore and README)
  • generate documentation from docstrings (fix e.g. formatting issues if present)
  • optionally add page about installation/first steps/etc.
@pylipp pylipp mentioned this issue Oct 10, 2019
Closed
@pylipp
Copy link
Owner Author

pylipp commented Oct 28, 2019 •
edited

Consider using pydocstyle to polish docstrings.

@pylipp
Copy link
Owner Author

pylipp commented May 31, 2022

Closed since irrelevant. Developers can read the docstrings, users shall read the readme and use --help.

@pylipp pylipp closed this as completed May 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pylipp