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.

Sign up for GitHub

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

Jump to bottom

Authoring: Add primer about linking and (cross-) referencing with Sphinx #468

Merged
merged 3 commits into from
Mar 4, 2024
Merged

Authoring: Add primer about linking and (cross-) referencing with Sphinx #468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c0efeb
Linking: Add primer about linking and (cross-) referencing with Sphinx
amotl Mar 1, 2024
0d31f77
Linking: Refactor previous "links" page, and improve "index" page
amotl Mar 1, 2024
b9408db
Linking: Last-minute adjustments
amotl Mar 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions docs/index.rst
View file
Open in desktop
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