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:
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.
Description of problem:
README.mdfile itself.README.mdcluttered. Also, with the addition of new features to the project, documentation will also be expanded.README.md.Expected:
docs/inside the root directory of the project.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.