Skip to content

Commit

Permalink
Add primer about linking and (cross-) referencing with Sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Mar 1, 2024
1 parent ee75bef commit 45562b6
Show file tree
Hide file tree
Showing 3 changed files with 382 additions and 19 deletions.
37 changes: 21 additions & 16 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
.. _index:

###########################
CrateDB documentation theme
CrateDB Documentation Theme
###########################

Sphinx makes it easy to create intelligent and beautiful documentation.

*****
About
*****

A theme component for the `Sphinx static documentation generator`_ used by
all the Crate.io documentation projects. Examples:

- `CrateDB Reference`_
- `CrateDB Python Client`_
A theme component for the `Sphinx`_ static documentation generator used by
the `CrateDB Documentation`_ across the board.


********
Overview
Features
********

This section outlines a few features, elements, and style-guides by example.
Specific features and elements.

.. toctree::
:maxdepth: 1

links


************
Style Guides
************

Style-guides by example.


Modernized
Expand Down Expand Up @@ -60,13 +66,13 @@ The legacy feature gallery exclusively uses reStructuredText.
admonitions
lists
tables
links
images
diagrams
codesnippets
typography
subpage
glossary
projects



Expand Down Expand Up @@ -102,8 +108,7 @@ How to improve this documentation:
Assurance* (QA) workflow, see the `developer guide`_.


.. _CrateDB Python Client: https://cratedb.com/docs/python/
.. _CrateDB Reference: https://cratedb.com/docs/crate/reference/
.. _CrateDB Documentation: https://cratedb.com/docs/
.. _developer guide: https://github.com/crate/crate-docs-theme/blob/main/DEVELOP.rst
.. _report an issue: https://github.com/crate/crate-docs-theme/issues/new
.. _Sphinx static documentation generator: https://www.sphinx-doc.org/
.. _Sphinx: https://www.sphinx-doc.org/
Loading

0 comments on commit 45562b6

Please sign in to comment.