CrateDB Documentation Theme

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for amotl from gravatar.com amotl Avatar for Mathias.Fussenegger from gravatar.com Mathias.Fussenegger Avatar for matkuliak from gravatar.com matkuliak Avatar for matriv from gravatar.com matriv Avatar for smu from gravatar.com smu Avatar for walbeh from gravatar.com walbeh

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache License 2.0)
  • Author: Crate.IO GmbH
  • Tags cratedb, docs, sphinx, readthedocs
  • Requires: Python >=3.9
Classifiers

Project description

CI status Read the Docs status PyPI version crate-docs version 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

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, 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.

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?

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for amotl from gravatar.com amotl Avatar for Mathias.Fussenegger from gravatar.com Mathias.Fussenegger Avatar for matkuliak from gravatar.com matkuliak Avatar for matriv from gravatar.com matriv Avatar for smu from gravatar.com smu Avatar for walbeh from gravatar.com walbeh

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache License 2.0)
  • Author: Crate.IO GmbH
  • Tags cratedb, docs, sphinx, readthedocs
  • Requires: Python >=3.9
Classifiers

Release history Release notifications | RSS feed

This version

0.37.0

0.37.0.dev0 pre-release

0.36.1

0.36.0

0.35.1.dev0 pre-release

0.35.0

0.35.0.dev4 pre-release

0.35.0.dev3 pre-release

0.35.0.dev2 pre-release

0.35.0.dev1 pre-release

0.34.1

0.34.0

0.34.0.dev6 pre-release

0.34.0.dev5 pre-release

0.34.0.dev4 pre-release

0.34.0.dev3 pre-release

0.34.0.dev2 pre-release

0.34.0.dev1 pre-release

0.33.2

0.33.1

0.33.1.dev0 pre-release

0.33.0

0.32.4

0.32.4.dev2 pre-release

0.32.4.dev1 pre-release

0.32.4.dev0 pre-release

0.32.3

0.32.2

0.32.1

0.32.0

0.32.0.dev16 pre-release

0.32.0.dev15 pre-release

0.32.0.dev14 pre-release

0.32.0.dev13 pre-release

0.32.0.dev12 pre-release

0.32.0.dev11 pre-release

0.32.0.dev10 pre-release

0.32.0.dev9 pre-release

0.32.0.dev8 pre-release

0.32.0.dev7 pre-release

0.32.0.dev6 pre-release

0.32.0.dev5 pre-release

0.32.0.dev4 pre-release

0.32.0.dev3 pre-release

0.32.0.dev2 pre-release

0.32.0.dev1 pre-release

0.32.0.dev0 pre-release

0.31.2

0.31.1

0.31.0

0.30.0

0.30.0.dev8 pre-release

0.30.0.dev7 pre-release

0.30.0.dev6 pre-release

0.30.0.dev5 pre-release

0.30.0.dev4 pre-release

0.30.0.dev3 pre-release

0.30.0.dev2 pre-release

0.30.0.dev1 pre-release

0.29.10

0.29.9

0.29.8

0.29.7

0.29.6

0.29.5

0.29.4

0.29.3

0.29.2

0.29.1

0.29.0

0.29.0.dev1 pre-release

0.28.2

0.28.1

0.28.0 yanked

Reason this release was yanked:

Discovered a few regressions.

0.27.1

0.27.0

0.26.5

0.26.4 yanked

Reason this release was yanked:

Wheel is too small and does not contain bundle artefacts.

0.26.3

0.26.2

0.26.1

0.26.0

0.25.0

0.25.0rc1 pre-release

0.24.5

0.24.4

0.24.3

0.24.2

0.24.1

0.24.0

0.23.0

0.22.3

0.22.2

0.22.1

0.22.0

0.21.4

0.21.3

0.21.2

0.21.1

0.21.0

0.20.1

0.20.0

0.19.1

0.19.0

0.18.0

0.17.0

0.16.1

0.16.0

0.15.4

0.15.2

0.15.1

0.15.0

0.14.1

0.14.0

0.13.3

0.13.2

0.13.1

0.13.0

0.12.0

0.11.0

0.11.0b2 pre-release

0.11.0b1 pre-release

0.10.17

0.10.16

0.10.15

0.10.14

0.10.13

0.10.12

0.10.11

0.10.10

0.10.9

0.10.8

0.10.7

0.10.6

0.10.5

0.10.4

0.10.3

0.10.2

0.10.1

0.10.0

0.9.6

0.9.5

0.9.4

0.9.3

0.9.2

0.9.1

0.9.0

0.8.3

0.8.2

0.8.1

0.8.0

0.7.5

0.7.4

0.7.3

0.7.2

0.7.1

0.7.0

0.6.0

0.5.85

0.5.84

0.5.83

0.5.82

0.5.81

0.5.80

0.5.79

0.5.78

0.5.77

0.5.76

0.5.74

0.5.73

0.5.72

0.5.71

0.5.70

0.5.69

0.5.68

0.5.67

0.5.66

0.5.65

0.5.64

0.5.63

0.5.62

0.5.61

0.5.60

0.5.59

0.5.58

0.5.57

0.5.56

0.5.55

0.5.54

0.5.53

0.5.52

0.5.51

0.5.48

0.5.47

0.5.46

0.5.45

0.5.44

0.5.43

0.5.42

0.5.41

0.5.40

0.5.39

0.5.38

0.5.37

0.5.36

0.5.35

0.5.34

0.5.33

0.5.32

0.5.31

0.5.30

0.5.29

0.5.28

0.5.27

0.5.26

0.5.25

0.5.24

0.5.23

0.5.22

0.5.21

0.5.20

0.5.19

0.5.18

0.5.17

0.5.16

0.5.15

0.5.14

0.5.13

0.5.12

0.5.11

0.5.10

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.3

0.4.2

0.4.1

0.4.0

0.3.9

0.3.8

0.3.7

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.7

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crate_docs_theme-0.37.0.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

crate_docs_theme-0.37.0-py3-none-any.whl (2.2 MB view details)

Uploaded Python 3

File details

Details for the file crate_docs_theme-0.37.0.tar.gz.

File metadata

  • Download URL: crate_docs_theme-0.37.0.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for crate_docs_theme-0.37.0.tar.gz
Algorithm Hash digest
SHA256 97f5b58c1fdc8755c32ba1cb075eef209faabfdfc8e1d4d8b04de5be636d7376
MD5 a5a2219232b2f16fa1883003fbb5e73a
BLAKE2b-256 5ffecbd0689d6f90ccec8d9884b63e11a3bdbe1a54a636584c8940eede5b5a14

See more details on using hashes here.

File details

Details for the file crate_docs_theme-0.37.0-py3-none-any.whl.

File metadata

File hashes

Hashes for crate_docs_theme-0.37.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dcadaa7766f6364b064d199f57b17a583b53c9f5931fe022ce9d9ee2207ef25c
MD5 a332280aa43a9e878b619f2f774c2777
BLAKE2b-256 332b910d7a7e7a40f68fd616a859ac12f29bf10e39e54facc7a94305cb2607fb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page