sphinx-docs-opinionated-quickstart documentation¶
This is the main page for the sphinx-docs-opinionated-quickstart documentation. Other pages are available for you to navigate and explore below. For more information, see the repo on GitHub.
About:¶
General advice on reStructuredText¶
Writing reStructuredText is not intuitive to a first-time author. Therefore, I find using a set of common standards is helpful to maintain style and consistency across documentation. For reStructuredText specifically, two places with helpful markup documentation are listed below:
Additionally, I always use the Sphinx style guide for writing the same style across documents.