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.

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

Add Sphinx Documentation for ReadTheDocs #1

Open
medley56 opened this issue Oct 5, 2024 · 0 comments
Open

Add Sphinx Documentation for ReadTheDocs #1

medley56 opened this issue Oct 5, 2024 · 0 comments

Comments

@medley56
Copy link
Collaborator

medley56 commented Oct 5, 2024

Context

The Curryer codebase is undeniably useful but we should support users by publishing documentation about installation, usage, and the scope of what the library does and doesn't do. This should include the top level README included on the front page of the docs, and subsections for users and developers who wish to contribute to the project.

Suggested Implementation

  • Create a Sphinx build setup in the docs directory, using either rst or markdown for the documentation pages.
  • Create sections in docs for user documentation and developer documentation (stubs for now).
  • Add autogenerated API documentation using Sphinx autoapi or a similar extension to generate docs from docstrings in the codebase.
  • Polish the README file to include a reference to the ReadTheDocs site, short description of the repo, and installation instructions.
  • Link the GitHub project with ReadTheDocs to automatically publish documentation on push, including for PRs (ReadTheDocs supports this out of the box)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant