diff --git a/README.md b/README.md index bf01d30..8ec535a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,70 @@ # Nefertiti for Sphinx -Nefertiti for Sphinx is yet another Sphinx theme. +Nefertiti is a theme for [Sphinx](https://www.sphinx-doc.org/en/master/) that features: -Here is a screenshot, but visiting the [documentation site](https://sphinx-nefertiti.readthedocs.io/en/latest/) will give a more comprehensive idea. +* Responsive design, based on `Bootstrap 5.3 `_. +* Text input field to filter the **index**. +* Font configuration compliant with `EU's GDPR `_. +* Different fonts can be used for different elements. +* Light and dark color schemes, for normal text and code highlighted with Pygments styles. +* Diverse color sets are available: blue, indigo, purple, pink, red, orange, yellow, ... +* Optional highlighting of the project repository in the header. +* Optional project version selector in the header. +* Customizable footer links. -![screenshot](https://github.com/danirus/sphinx-nefertiti/raw/main/docs/source/_static/img/screenshot.png) +## Index filtering + + + +By default the **index** shows the content folded. Opening or closing items is remembered while browsing the documentation. + +To quickly find items use the input filter. The filter will display items that could be unvisible within a folded item. + +In the sample animated image the user looks for the item "Architecture", which is folded within the "Advance topics" entry. While typing the index shows entries that match the input field. + +After clearing the input field the index displays itself again with the folded and unfolded items the user had selected. + +## The TOC on the right side + + + +The Table of Contents, displayed on the right side of the page, spans itself to the right border of the browser to display long items, improving readability. + +## Other features + +Nefertiti for Sphinx comes with the following color sets. Change between them using the attribute `display` of the `html_theme_options` setting. + + + +In order to be compliant with [EU's GDPR](https://gdpr.eu/), Nefertiti for Sphinx comes bundled with a group of fonts licensed for free distribution. Adding more fonts is explained in the [User's Guide](https://sphinx-nefertiti.readthedocs.io/en/latest/users-guide/customization/fonts.html#adding-fonts): + +* Assistant +* Exo +* Montserrat +* Mulish +* Nunito +* Open Sans +* Red Hat Display +* Sofia Sans +* Ubuntu +* Varta +* Work Sans +* Fira Code (monospace) +* Red Hat Mono (monospace) +* Ubuntu Mono (monospace) + +Combine up to 5 different fonts: + + html_theme_options = { + "sans_serif_font": "Nunito", + "documentation_font": "Open Sans", + "monospace_font": "Ubuntu Mono", + "project_name_font": "Nunito", + "doc_headers_font": "Georgia", + + "documentation_font_size": "1.2rem", + "monospace_font_size": "1.1rem", + } ## To use it diff --git a/docs/source/_static/img/colorsets.png b/docs/source/_static/img/colorsets.png new file mode 100644 index 0000000..215dd2a Binary files /dev/null and b/docs/source/_static/img/colorsets.png differ diff --git a/docs/source/_static/img/index-filtering.gif b/docs/source/_static/img/index-filtering.gif new file mode 100644 index 0000000..efe881e Binary files /dev/null and b/docs/source/_static/img/index-filtering.gif differ diff --git a/docs/source/_static/img/index-filtering.mov b/docs/source/_static/img/index-filtering.mov new file mode 100644 index 0000000..e9c3427 Binary files /dev/null and b/docs/source/_static/img/index-filtering.mov differ diff --git a/docs/source/_static/img/toc.png b/docs/source/_static/img/toc.png new file mode 100644 index 0000000..04e44e3 Binary files /dev/null and b/docs/source/_static/img/toc.png differ diff --git a/sphinx_nefertiti/layout.html b/sphinx_nefertiti/layout.html index b00bf7b..e4e5bb5 100644 --- a/sphinx_nefertiti/layout.html +++ b/sphinx_nefertiti/layout.html @@ -138,7 +138,7 @@ {% include "searchbox.html" %} -
+