From 451a22ef6766c65b0e532633020f55ad360e36d5 Mon Sep 17 00:00:00 2001 From: Hagen Wierstorf Date: Tue, 20 Oct 2020 09:22:21 +0200 Subject: [PATCH] Add feature description to readme --- README.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.rst b/README.rst index a903b17..c7aa26a 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,20 @@ Sphinx audEERING theme Sphinx_ theme to style your documentation project with audEERING colors. +The theme extends the official `readthedocs theme`_ by + +* audEERING colors and logo +* support for wide pages, useful for wide tables +* better formatting of tables +* custom styling of figure captions +* make `juptyer-sphinx`_ code cells appear like normal code cells +* custom styling for `copy-button`_ and nbsphinx_ + .. _Sphinx: http://www.sphinx-doc.org/ +.. _readthedocs theme: https://sphinx-rtd-theme.readthedocs.io/ +.. _juptyer-sphinx: https://jupyter-sphinx.readthedocs.io/ +.. _copy-button: https://sphinx-copybutton.readthedocs.io/ +.. _nbsphinx: https://nbsphinx.readthedocs.io/ .. badges images and links: .. |tests| image:: https://github.com/audeering/sphinx-audeering-theme/workflows/Test/badge.svg