ANN: "insipid" Sphinx theme, release 0.2.0

[Matthias Geier]

Dear list.

I've already announced my new Sphinx theme "insipid" right here two months ago.

Since then, I've tuned the colors to make them less annoying and more
insipid. I hope you like them!

Here's the theme documentation (and at the same time a usage example):

https://insipid-sphinx-theme.readthedocs.io/

The usage should be really simple:

1. Install the Python package insipid-sphinx-theme
2. Add html_theme = 'insipid' to your conf.py
3. Run Sphinx!

It would be great if you could try it out and give feedback (either
here on the list or at
https://github.com/mgeier/insipid-sphinx-theme/issues)!

There are certainly many things that can (and should) be improved, I'd
love to hear your suggestions.

There aren't a lot of example projects yet, I've just tried it out on
a few projects I'm currently working on:

https://nbsphinx.readthedocs.io/
https://python-sounddevice.readthedocs.io/en/latest/
https://python-rtmixer.readthedocs.io/
https://jackclient-python.readthedocs.io/
https://mg.readthedocs.io/
https://jupyter-format.readthedocs.io/
https://audioscenedescriptionformat.readthedocs.io/
https://splines.readthedocs.io/

I've mostly tested the theme on multiple browsers on Linux and
Android, it would be great to get some coverage on Windows, macOS, iOS
and whatever other OS you are using!

cheers,
Matthias

[Varenne Riocha]

Hi

 

I am a beginner and still playing with a single Sphinx project. I could swap the theme to yours and build it correctly. The very first time I ran "make html" (after "source ./my/bin/activate) it threw a bunch of warnings (in red). Here are they

Requirement already satisfied: pyparsing>=2.0.2 in /home/vr/.pythonenv/lib/python3.7/site-packages (from packaging->sphinx>=3.1.2->insipid-sphinx-theme) (2.4.7)
Installing collected packages: jinja2, insipid-sphinx-theme
  Attempting uninstall: jinja2
    Found existing installation: Jinja2 2.10.1
    Uninstalling Jinja2-2.10.1:
      Successfully uninstalled Jinja2-2.10.1
ERROR: After October 2020 you may experience errors when installing or updating packages. This is because pip will change the way that it resolves dependency conflicts.

We recommend you use --use-feature=2020-resolver to test your packages with the new resolver before it becomes the default.

sphinx-book-theme 0.0.36 requires docutils>=0.15, but you'll have docutils 0.14 which is incompatible.
myst-parser 0.12.10 requires docutils>=0.15, but you'll have docutils 0.14 which is incompatible.
myst-nb 0.10.1 requires docutils>=0.15, but you'll have docutils 0.14 which is incompatible.
landslide 1.1.8 requires Jinja2==2.10.1, but you'll have jinja2 2.11.2 which is incompatible.
jupyter-book 0.8.2 requires docutils>=0.15, but you'll have docutils 0.14 which is incompatible.

Other than that I get the expected result.

BTW, your theme is very fluid and light. Congrats, and thanks for the great work!

Varenne

[Matthias Geier]

Yes, I've seen this error and it is not specifically related to the
insipid theme or even to Sphinx itself.

It's more of a warning because the behavior of "pip" is in the process
of changing.

If you want to check whether everything is ok, you can use the option
that's mentioned in the error text:

python3 -m pip install insipid-sphinx-theme --use-feature=2020-resolver

If this doesn't produce any errors, everything is fine.

There is only one thing to notice if you are using readthedocs.org:
https://github.com/readthedocs/readthedocs.org/issues/7362

But this problem will hopefully go away automatically with the new
"pip" resolver.

> BTW, your theme is very fluid and light. Congrats, and thanks for the great work!

Thanks a lot!

If you have any ideas for improvements, please let me know!

cheers,
Matthias

[bradley...@gmail.com]

I have tried insipid and I have two questions:

1. How does on change the  color  used for in-line literal font; e.g., ``test``  ?

2. Is there a way to only use titles in the navigation, like read rtd_theme does when titles_only is True; see
https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#theme-options

[Matthias Geier]

On Sun, Nov 8, 2020 at 12:49 PM bradley...@gmail.com wrote:
>
> I have tried insipid and I have two questions:
>
> 1. How does on change the color used for in-line literal font; e.g., ``test`` ?

There isn't a single setting, multiple CSS classes are used for that,
which are defined there:
https://github.com/mgeier/insipid-sphinx-theme/blob/96fb5c3c155cde3be1f537ee5b1f94b4526b4e97/src/insipid_sphinx_theme/insipid/static/insipid.css_t#L259-L270

Currently, the theme is not prepared to easily support multiple color
themes (i.e. there are no CSS variables defined for the colors). If
you want to help out with that, you can leave a comment at
https://github.com/mgeier/insipid-sphinx-theme/issues/5

> 2. Is there a way to only use titles in the navigation, like read rtd_theme does when titles_only is True; see
> https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#theme-options

The "insipid" theme uses the navigation/TOC provided by Sphinx, while
"sphinx_rtd_theme" uses custom Python code to generate theirs.
Therefore, it has somewhat different options and behavior.

You might get a similar effect by using the :titlesonly: flag on the
"toctree" directive, see
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree.

Does that do what you want?

Maybe you can use :maxdepth:?

If not, you are of course free to replace the default template
"globaltoc.html" with your custom version (probably based on the one
from the RTD theme). See also
file:///home/mg/git/insipid-sphinx-theme/build/sphinx/html/configuration.html#confval-html_sidebars

cheers,
Matthias

[Daniel Scott]

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAFesC-eovXe08sbBaMa0T2HK%3DjC4051P9C-GR7yVwLkEY34krw%40mail.gmail.com.