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

Document codebase and generate web docs with Sphinx #71

Open
daemon opened this issue Apr 4, 2021 · 0 comments
Open

Document codebase and generate web docs with Sphinx #71

daemon opened this issue Apr 4, 2021 · 0 comments

Comments

@daemon
Copy link
Member

daemon commented Apr 4, 2021

  1. Document the codebase.
  2. Generate HTML documentation using Sphinx with the Napoleon and autodoc extensions.
  3. Write some tutorials and getting started guides.
  4. Create a GitHub page for Howl with the root directory set to docs/.

See https://flask.palletsprojects.com/en/1.1.x/ for a good Sphinx example.
This was referenced Apr 16, 2021
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@daemon