crate-docs-theme


Namecrate-docs-theme JSON
Version 0.38.1 PyPI version JSON
download
home_pagehttps://github.com/crate/crate-docs-theme
SummaryCrateDB Documentation Theme
upload_time2025-03-07 08:37:32
maintainerNone
docs_urlNone
authorCrate.IO GmbH
requires_python>=3.9
licenseApache License 2.0
keywords cratedb docs sphinx readthedocs
VCS
bugtrack_url
requirements build setuptools twine wheel
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===========================
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, 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?

- Check out our `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/

            

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/73/06/d9bb9bf4aafad9d8fcf84d31c132bd53f65fe6a01d2e211c93581af898be/crate_docs_theme-0.38.1.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, seamlessly interlinked via the CrateDB Documentation Theme.\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\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.38.1",
    "project_urls": {
        "Homepage": "https://github.com/crate/crate-docs-theme"
    },
    "split_keywords": [
        "cratedb",
        "docs",
        "sphinx",
        "readthedocs"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4e6f3366f084bf49d3481c4787c05512f59323c2625820ab9b495bfbbffa2c23",
                "md5": "90e2771f1877e83c8746cfea3a344ec8",
                "sha256": "4791245e590c2d8a8e741f4a9788589f7936c68a64972c71eca4cdb777c7ee6b"
            },
            "downloads": -1,
            "filename": "crate_docs_theme-0.38.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "90e2771f1877e83c8746cfea3a344ec8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 2187817,
            "upload_time": "2025-03-07T08:37:29",
            "upload_time_iso_8601": "2025-03-07T08:37:29.177062Z",
            "url": "https://files.pythonhosted.org/packages/4e/6f/3366f084bf49d3481c4787c05512f59323c2625820ab9b495bfbbffa2c23/crate_docs_theme-0.38.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7306d9bb9bf4aafad9d8fcf84d31c132bd53f65fe6a01d2e211c93581af898be",
                "md5": "d14d583221e3bfdc556e16a3f6df5161",
                "sha256": "6bc1513c1c2d06287b47df96d9ce9d6870818b6188b8f0791556e423388ee9b8"
            },
            "downloads": -1,
            "filename": "crate_docs_theme-0.38.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d14d583221e3bfdc556e16a3f6df5161",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 2124702,
            "upload_time": "2025-03-07T08:37:32",
            "upload_time_iso_8601": "2025-03-07T08:37:32.541173Z",
            "url": "https://files.pythonhosted.org/packages/73/06/d9bb9bf4aafad9d8fcf84d31c132bd53f65fe6a01d2e211c93581af898be/crate_docs_theme-0.38.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-07 08:37:32",
    "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"
}
        
Elapsed time: 0.42925s