Sphinx makes it easy to create intelligent and beautiful documentation.
A theme component for the Sphinx static documentation generator used by the CrateDB Documentation across the board.
Introduction
.. toctree::
:maxdepth: 1
authoring
links
Style Guides
A few markup snippets by example.
A side-by-side gallery demonstrating both reStructuredText and Markedly Structured Text syntax.
.. grid::
.. grid-item::
:columns: 6
.. toctree::
:titlesonly:
rst/index
.. grid-item::
:columns: 6
.. toctree::
:titlesonly:
myst/index
The legacy feature gallery exclusively uses reStructuredText.
.. toctree::
:maxdepth: 1
headings
admonitions
lists
tables
images
diagrams
codesnippets
typography
subpage
glossary
projects
This is a sample documentation project that can be used for visually testing the theme.
How to use this documentation:
- Verify that each page element displays correctly. Some page elements identify themselves (e.g., the :ref:`index`) and some elements describe how they ought to appear (e.g., the :ref:`admonition gallery <admonition-gallery>`).
How to improve this documentation:
- If you notice any bugs, please report an issue or create a PR to fix them.
- Add page elements and use the available text to describe how the element should be displayed.
Note
To learn how to run sandbox or CI builds as a part of your testing and Quality Assurance (QA) workflow, see the developer guide.