|tests| |rtd| |pypi| |build| |python-versions|
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_.
The demo/preview project is rendered and published to https://crate-docs-theme.readthedocs.io/.
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/
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.
The documentation is composed of multiple separate documentation projects, seamlessly interlinked via the CrateDB Documentation Theme.
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.
This project is primarily maintained by Crate.io_, but we welcome community
contributions!
See the developer docs_ and the contribution docs_ for more information.
Looking for more help?
support channels_.. _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/
FAQs
CrateDB Documentation Theme
We found that crate-docs-theme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.