https://github.com/scylladb/sphinx-scylladb-theme

The documentation toolchain for Scylla projects.
https://github.com/scylladb/sphinx-scylladb-theme

documentation sphinx sphinx-doc sphinx-theme theme

Last synced: 10 months ago
JSON representation

The documentation toolchain for Scylla projects.

• Host: GitHub
• URL: https://github.com/scylladb/sphinx-scylladb-theme
• Owner: scylladb
• License: apache-2.0
• Created: 2020-02-29T10:53:43.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-06T12:18:11.000Z (over 1 year ago)
• Last Synced: 2024-12-06T13:46:14.583Z (over 1 year ago)
• Topics: documentation, sphinx, sphinx-doc, sphinx-theme, theme
• Language: Python
• Homepage: https://sphinx-theme.scylladb.com
• Size: 56.9 MB
• Stars: 12
• Watchers: 2
• Forks: 14
• Open Issues: 32
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

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

ScyllaDB Sphinx Theme

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

.. image:: https://github.com/scylladb/sphinx-scylladb-theme/actions/workflows/docs-pages.yaml/badge.svg

   :target: https://github.com/scylladb/sphinx-scylladb-theme/actions/workflows/docs-pages.yaml

The documentation toolchain for ScyllaDB projects.

.. image:: https://github.com/scylladb/sphinx-scylladb-theme/blob/master/docs/source/deployment/images/preview.png

Features

--------

**Shared Design**

All ScyllaDB documentation sites share a common look and feel.

**Multiversion Support**

Build docs for different versions of your project.

**GitHub Pages Support**

Automatically publish documentation to GitHub Pages.

For more information about the stack, see `Toolchain `_.

Installation

------------

To add the toolchain to a ScyllaDB project, see the `Getting Started `_ section of our docs.

Usage

-----

For more documentation, see `sphinx-theme.scylladb.com `_.

License

-------

Copyright (c) 2020-present ScyllaDB Licensed under the `Apache License 2.0 `_.