===========================
CrateDB Documentation Theme
===========================
|tests| |rtd| |pypi| |build| |python-versions|
About
=====
A `Sphinx`_ theme for the `CrateDB documentation`_.
*Note: This theme is tightly integrated into the cratedb.com website and is
not intended for general use.*
For making changes to the theme, see the `developer docs`_.
Preview
=======
The demo/preview project is rendered and published to https://crate-docs-theme.readthedocs.io/.
Using the theme
===============
Prerequisites
-------------
The documentation can include UML diagrams which will be rendered using
`sphinxcontrib-plantuml`_. In order to satisfy its requirements, run::
# On Linux
apt-get install plantuml
# On macOS
brew install plantuml
.. _sphinxcontrib-plantuml: https://pypi.org/project/sphinxcontrib-plantuml/
Installation
------------
The CrateDB Documentation Theme is available as a package on `PyPI`_. However, there is no
need to install it yourself. CrateDB projects that use the theme should install
it automatically.
Configuration
-------------
The documentation is composed of multiple separate documentation
projects, interlinked via the CrateDB Documentation Theme.
To update the root of the TOC sidebar for the entire documentation, update the
`sidebartoc.html`` file.
To use the theme, add this line to your Sphinx ``conf.py`` file::
from crate.theme.rtd.conf.foo import *
Here, replace ``foo`` with the appropriate module for your documentation
project.
Contributing
============
This project is primarily maintained by `Crate.io`_, but we welcome community
contributions!
See the `developer docs`_ and the `contribution docs`_ for more information.
Help
====
Looking for more help?
- Check out our `support channels`_
.. _sidebartoc.html: src/crate/theme/rtd/crate/templates/crate/sidebartoc.html
.. _contribution docs: CONTRIBUTING.rst
.. _Crate.io: https://cratedb.com
.. _CrateDB documentation: https://cratedb.com/docs/
.. _developer docs: DEVELOP.rst
.. _PyPI: https://pypi.python.org/
.. _Sphinx: http://www.sphinx-doc.org/en/stable/
.. _support channels: https://cratedb.com/support/
.. |tests| image:: https://github.com/crate/crate-docs-theme/workflows/docs/badge.svg
:alt: CI status
:target: https://github.com/crate/crate-docs-theme/actions?workflow=docs
.. |rtd| image:: https://readthedocs.org/projects/crate-docs-theme/badge/
:alt: Read the Docs status
:target: https://readthedocs.org/projects/crate-docs-theme/
.. |build| image:: https://img.shields.io/endpoint.svg?color=blue&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcrate%2Fcrate-docs-theme%2Fmain%2Fdocs%2Fbuild.json
:alt: crate-docs version
:target: https://github.com/crate/crate-docs-theme/blob/main/docs/build.json
.. |pypi| image:: https://badge.fury.io/py/crate-docs-theme.svg
:alt: PyPI version
:target: https://badge.fury.io/py/crate-docs-theme
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/crate-docs-theme.svg
:alt: Python Versions
:target: https://pypi.org/project/crate-docs-theme/
Raw data
{
"_id": null,
"home_page": "https://github.com/crate/crate-docs-theme",
"name": "crate-docs-theme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "cratedb docs sphinx readthedocs",
"author": "Crate.IO GmbH",
"author_email": "office@crate.io",
"download_url": "https://files.pythonhosted.org/packages/51/7d/4068e3a99ddd922067b4f36e45a0185bd01cb0739092cdab78d4372a9cad/crate_docs_theme-0.41.0.tar.gz",
"platform": null,
"description": "===========================\nCrateDB Documentation Theme\n===========================\n\n|tests| |rtd| |pypi| |build| |python-versions|\n\n\nAbout\n=====\n\nA `Sphinx`_ theme for the `CrateDB documentation`_.\n\n*Note: This theme is tightly integrated into the cratedb.com website and is\nnot intended for general use.*\n\nFor making changes to the theme, see the `developer docs`_.\n\n\nPreview\n=======\n\nThe demo/preview project is rendered and published to https://crate-docs-theme.readthedocs.io/.\n\n\nUsing the theme\n===============\n\nPrerequisites\n-------------\n\nThe documentation can include UML diagrams which will be rendered using\n`sphinxcontrib-plantuml`_. In order to satisfy its requirements, run::\n\n # On Linux\n apt-get install plantuml\n\n # On macOS\n brew install plantuml\n\n.. _sphinxcontrib-plantuml: https://pypi.org/project/sphinxcontrib-plantuml/\n\nInstallation\n------------\n\nThe CrateDB Documentation Theme is available as a package on `PyPI`_. However, there is no\nneed to install it yourself. CrateDB projects that use the theme should install\nit automatically.\n\n\nConfiguration\n-------------\n\nThe documentation is composed of multiple separate documentation\nprojects, interlinked via the CrateDB Documentation Theme.\n\nTo update the root of the TOC sidebar for the entire documentation, update the\n`sidebartoc.html`` file.\n\nTo use the theme, add this line to your Sphinx ``conf.py`` file::\n\n from crate.theme.rtd.conf.foo import *\n\nHere, replace ``foo`` with the appropriate module for your documentation\nproject.\n\n\nContributing\n============\n\nThis project is primarily maintained by `Crate.io`_, but we welcome community\ncontributions!\n\nSee the `developer docs`_ and the `contribution docs`_ for more information.\n\n\nHelp\n====\n\nLooking for more help?\n\n- Check out our `support channels`_\n\n.. _sidebartoc.html: src/crate/theme/rtd/crate/templates/crate/sidebartoc.html\n.. _contribution docs: CONTRIBUTING.rst\n.. _Crate.io: https://cratedb.com\n.. _CrateDB documentation: https://cratedb.com/docs/\n.. _developer docs: DEVELOP.rst\n.. _PyPI: https://pypi.python.org/\n.. _Sphinx: http://www.sphinx-doc.org/en/stable/\n.. _support channels: https://cratedb.com/support/\n\n\n.. |tests| image:: https://github.com/crate/crate-docs-theme/workflows/docs/badge.svg\n :alt: CI status\n :target: https://github.com/crate/crate-docs-theme/actions?workflow=docs\n\n.. |rtd| image:: https://readthedocs.org/projects/crate-docs-theme/badge/\n :alt: Read the Docs status\n :target: https://readthedocs.org/projects/crate-docs-theme/\n\n.. |build| image:: https://img.shields.io/endpoint.svg?color=blue&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcrate%2Fcrate-docs-theme%2Fmain%2Fdocs%2Fbuild.json\n :alt: crate-docs version\n :target: https://github.com/crate/crate-docs-theme/blob/main/docs/build.json\n\n.. |pypi| image:: https://badge.fury.io/py/crate-docs-theme.svg\n :alt: PyPI version\n :target: https://badge.fury.io/py/crate-docs-theme\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/crate-docs-theme.svg\n :alt: Python Versions\n :target: https://pypi.org/project/crate-docs-theme/\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "CrateDB Documentation Theme",
"version": "0.41.0",
"project_urls": {
"Homepage": "https://github.com/crate/crate-docs-theme"
},
"split_keywords": [
"cratedb",
"docs",
"sphinx",
"readthedocs"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9be21d0e85bc6813bf89095c283eca66ca62e621b208b0925659b26e24afb644",
"md5": "e845fb056274b94e2eb4ee1b13a419f3",
"sha256": "b0a2601d567df692a0d6eb27d287993d45efe9ead857736712c629bd2143196e"
},
"downloads": -1,
"filename": "crate_docs_theme-0.41.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e845fb056274b94e2eb4ee1b13a419f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1647274,
"upload_time": "2025-10-08T15:24:23",
"upload_time_iso_8601": "2025-10-08T15:24:23.199266Z",
"url": "https://files.pythonhosted.org/packages/9b/e2/1d0e85bc6813bf89095c283eca66ca62e621b208b0925659b26e24afb644/crate_docs_theme-0.41.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "517d4068e3a99ddd922067b4f36e45a0185bd01cb0739092cdab78d4372a9cad",
"md5": "06b4cf38eecc286c5ee5e4c052bd1115",
"sha256": "b4c9f7ea108b3d085ffcedbe17750a606f316b528ec698315b11b60b151c76c3"
},
"downloads": -1,
"filename": "crate_docs_theme-0.41.0.tar.gz",
"has_sig": false,
"md5_digest": "06b4cf38eecc286c5ee5e4c052bd1115",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1585830,
"upload_time": "2025-10-08T15:24:25",
"upload_time_iso_8601": "2025-10-08T15:24:25.039968Z",
"url": "https://files.pythonhosted.org/packages/51/7d/4068e3a99ddd922067b4f36e45a0185bd01cb0739092cdab78d4372a9cad/crate_docs_theme-0.41.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-08 15:24:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "crate",
"github_project": "crate-docs-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "build",
"specs": []
},
{
"name": "setuptools",
"specs": []
},
{
"name": "twine",
"specs": []
},
{
"name": "wheel",
"specs": []
}
],
"lcname": "crate-docs-theme"
}
JSON
