Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crate/crate-docs-theme

A Sphinx theme for the CrateDB documentation.
https://github.com/crate/crate-docs-theme

Last synced: about 1 month ago
JSON representation

A Sphinx theme for the CrateDB documentation.

Host: GitHub
URL: https://github.com/crate/crate-docs-theme
Owner: crate
License: apache-2.0
Created: 2014-05-05T08:30:09.000Z (over 10 years ago)
Default Branch: main
Last Pushed: 2024-06-03T15:13:10.000Z (6 months ago)
Last Synced: 2024-06-11T16:59:02.688Z (6 months ago)
Language: CSS
Homepage: https://crate-docs-theme.readthedocs.io/
Size: 8.23 MB
Stars: 19
Watchers: 36
Forks: 5
Open Issues: 12
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-starred - crate/crate-docs-theme - A Sphinx theme for the CrateDB documentation. (others)

README

        ================

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