================
Crate Docs Theme
================
|tests| |rtd| |build| |pypi|
About
=====
A `Sphinx`_ theme for the `Crate documentation`_.
*Note: This theme is tightly integrated into the Crate.io 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 Crate docs theme is available as a package on `PyPI`_. However, there is no
need to install it yourself. Crate projects that use the theme should install
it automatically.
Configuration
-------------
The Crate.io documentation is composed of multiple separate documentation
projects, seamlessly interlinked via the Crate docs 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
.. _Crate 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
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.7",
"maintainer_email": null,
"keywords": "crate docs sphinx readthedocs",
"author": "Crate.IO GmbH",
"author_email": "office@crate.io",
"download_url": "https://files.pythonhosted.org/packages/89/e8/2dd628a59e2439c0ac8362cdf571db255fbdd25e7dc71272b295c1bc24a3/crate-docs-theme-0.31.1.tar.gz",
"platform": null,
"description": "================\nCrate Docs Theme\n================\n\n|tests| |rtd| |build| |pypi|\n\n\nAbout\n=====\n\nA `Sphinx`_ theme for the `Crate documentation`_.\n\n*Note: This theme is tightly integrated into the Crate.io 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 Crate docs theme is available as a package on `PyPI`_. However, there is no\nneed to install it yourself. Crate projects that use the theme should install\nit automatically.\n\n\nConfiguration\n-------------\n\nThe Crate.io documentation is composed of multiple separate documentation\nprojects, seamlessly interlinked via the Crate docs 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.. _Crate 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",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Crate Docs Theme",
"version": "0.31.1",
"project_urls": {
"Homepage": "https://github.com/crate/crate-docs-theme"
},
"split_keywords": [
"crate",
"docs",
"sphinx",
"readthedocs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9af66a247d8e0c1b0d3212049383262ddfe94fd2ce7b2b6f296a46ca4c36f87",
"md5": "61ec9331567888f4cbdf4f012f049863",
"sha256": "3f2bf7ffb2cd57a47e155569d99c1177bf033ab111017a215c711943fc89c02a"
},
"downloads": -1,
"filename": "crate_docs_theme-0.31.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61ec9331567888f4cbdf4f012f049863",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2102269,
"upload_time": "2024-04-10T14:34:06",
"upload_time_iso_8601": "2024-04-10T14:34:06.347766Z",
"url": "https://files.pythonhosted.org/packages/b9/af/66a247d8e0c1b0d3212049383262ddfe94fd2ce7b2b6f296a46ca4c36f87/crate_docs_theme-0.31.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "89e82dd628a59e2439c0ac8362cdf571db255fbdd25e7dc71272b295c1bc24a3",
"md5": "fa4a577c63ca0e5f2953b3a29b800c14",
"sha256": "2bccf4d4e7cd4734309be6ed7ffa77a1c1f9db1981af59b5ead7457d250a2e92"
},
"downloads": -1,
"filename": "crate-docs-theme-0.31.1.tar.gz",
"has_sig": false,
"md5_digest": "fa4a577c63ca0e5f2953b3a29b800c14",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 2054950,
"upload_time": "2024-04-10T14:34:11",
"upload_time_iso_8601": "2024-04-10T14:34:11.582328Z",
"url": "https://files.pythonhosted.org/packages/89/e8/2dd628a59e2439c0ac8362cdf571db255fbdd25e7dc71272b295c1bc24a3/crate-docs-theme-0.31.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 14:34:11",
"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
