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

Create Documentation in Sphinx reStructuredText Format. #60

Open
2 tasks
th4ruka opened this issue May 5, 2024 · 1 comment
Open
2 tasks

Create Documentation in Sphinx reStructuredText Format. #60

th4ruka opened this issue May 5, 2024 · 1 comment

Comments

@th4ruka
Copy link

th4ruka commented May 5, 2024

Description of problem:

  • Current user documentation (reference) of tinyweb is included in the README.md file itself.
  • I feel it makes README.md cluttered. Also, with the addition of new features to the project, documentation will also be expanded.
  • Therefore, I think it is more convenient to make the documentation separately, rather than including it in the README.md.

Expected:

  • Create a separate directory called docs/ inside the root directory of the project.
  • Use Sphinx and reStructuredText (reST) to create the documentation within docs/ directory.

Sphinx and reStructuredText (reST) is the same tool used by Micropython project. This tool makes it easier to convert the content in docs/ into different formats like HTML or PDF.

@th4ruka
Copy link
Author

th4ruka commented May 5, 2024

I'd be happy to help with this documentation improvement.

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