This release is a pre-release and may not be stable for production use.
CrateDB Documentation Theme
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
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.py 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
Metadata
Release files for crate-docs-theme 0.51.0.dev0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| crate_docs_theme-0.51.0.dev0.tar.gz | 1.6 MB | Without provenance | Details for crate_docs_theme-0.51.0.dev0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| crate_docs_theme-0.51.0.dev0-py3-none-any.whl | Python 3 | none | any | Details for crate_docs_theme-0.51.0.dev0-py3-none-any.whl |
Total release size: 3.2 MB
Release files / crate_docs_theme-0.51.0.dev0.tar.gz
| Download URL | crate_docs_theme-0.51.0.dev0.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
533d5ec88f0a589da95b9b98ef7752444bcac56f3581bbe81dbe85eb4cd60aaf
|
|
BLAKE2b-256 checksum How to use checksums |
3b1514390018d706eefeb1e7a049f6b522b617d6ebf6457324b6bc9d96930f2e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.14
|
Release files / crate_docs_theme-0.51.0.dev0-py3-none-any.whl
| Download URL | crate_docs_theme-0.51.0.dev0-py3-none-any.whl |
|---|---|
| Size | 1.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
de9c0c4e9ab23f68168b8ca0e9fad7cc43b436b60f2b9600758333fb3cb454fd
|
|
BLAKE2b-256 checksum How to use checksums |
8396b42967092b9bfdf53eb45eaced4a6349ae63f5a7e548752e9fcb873b5d75
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.14
|
Security for crate-docs-theme 0.51.0.dev0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.