Skip to content

Commit

Permalink
Fix README, prepare rel 0.2.3 (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
danirus authored Feb 20, 2024
1 parent ad26990 commit 914a974
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Change Log

## [0.2.2] - 2024-02-20
## [0.2.3] - 2024-02-20

- Use a fluid layout (Bootstrap's `container-fluid`) to allow expanding the TOC
in the right side to the right border of the browser. The goal is to increase
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -16,24 +16,24 @@ See it in action in [sphinx-themes.org](https://sphinx-themes.org/#theme-sphinx-

## Index filtering

<p align="center"><img align="center" width="315" height="417" src="docs/source/_static/img/index-filtering-1.png"></p>
<p align="center"><img align="center" width="315" height="417" src="https://github.com/danirus/sphinx-nefertiti/blob/main/docs/source/_static/img/index-filtering-1.png"></p>

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 invisible within a folded item. When the user types in the input field, let us say `fo`, the index gets filtered with all the entries that match those two characters. So the index will display three matches: `Fonts`, `Footer links` and `Footnotes`. Those three entries were all folded within their sections:

<p align="center"><img align="center" width="315" height="333" src="docs/source/_static/img/index-filtering-2.png"></p>
<p align="center"><img align="center" width="315" height="333" src="https://github.com/danirus/sphinx-nefertiti/blob/main/docs/source/_static/img/index-filtering-2.png"></p>


## The TOC on the right side

The Table of Contents, displayed on the right side, spans itself to the right border of the browser to display long items, improving readability.

<p align="center"><img width="412" height="306" src="docs/source/_static/img/toc.png"></p>
<p align="center"><img width="412" height="306" src="https://github.com/danirus/sphinx-nefertiti/blob/main/docs/source/_static/img/toc.png"></p>

## Other features

Nefertiti for Sphinx comes with the following color sets. Change between them using the attribute `display` of the `html_theme_options` setting.

<p align="center"><img width="768" height="462" src="docs/source/_static/img/colorsets.png"></p>
<p align="center"><img width="768" height="462" src="https://github.com/danirus/sphinx-nefertiti/blob/main/docs/source/_static/img/colorsets.png"></p>

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):

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "sphinx-nefertiti",
"version": "0.2.2",
"version": "0.2.3",
"private": true,
"description": "Private repository related with sphinx-nefertiti.",
"description": "Nefertiti is a theme for the Sphinx Documentation Generator.",
"engines": {
"node": ">=16"
},
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@

setup(
name="sphinx-nefertiti",
version="0.2.2",
version="0.2.3",
packages=find_packages(),
include_package_data=True,
license="MIT",

0 comments on commit 914a974

Please sign in to comment.