https://blog.readthedocs.comRead the Docs Blog - Posts tagged theme2024-01-10T23:05:11.226156+00:00ABloghttps://blog.readthedocs.com/theme-release-110/Announcing sphinx_rtd_theme 1.1.02022-11-01T00:00:00+00:00Benjamin Balder Bach<section id="announcing-sphinx-rtd-theme-1-1-0">
<p>We are happy to announce the release of new version of our theme, <a class="reference external" href="https://sphinx-rtd-theme.readthedocs.io/en/stable/">sphinx-rtd-theme</a>.
In this release, we have focused on bug fixes, backwards compatibility, and making the way for future releases.</p>
<section id="changes-and-new-features">
<h2>Changes and new features 💄</h2>
<p>Visually, we have a couple of small tweaks that most people won’t notice unless we mention them here 😇
The objective of the 1.1 release is to maintain backwards compatibility, and that also goes for the visual parts.</p>
<ul class="simple">
<li><p>The <code class="docutils literal notranslate"><span class="pre"><kbd></span></code> tag now has a nicer styling.</p></li>
<li><p>Breadcrumb styling has been updated.</p></li>
<li><p>Table cells with multiple paragraphs now have a correct formatting.</p></li>
<li><p>Definition lists are rendered correctly in API docs.</p></li>
<li><p>Issues with citation rendering and styling fixed.</p></li>
<li><p>Long URLs break into several lines instead of overflowing.</p></li>
</ul>
<img alt="../../../_images/sphinx-rtd-theme-110-screenshot1.png" class="align-right" src="../../../_images/sphinx-rtd-theme-110-screenshot1.png" style="width: 221.51999999999998px; height: 122.88px;" />
<img alt="../../../_images/sphinx-rtd-theme-110-screenshot2.png" class="align-right" src="../../../_images/sphinx-rtd-theme-110-screenshot2.png" style="width: 222.24px; height: 123.36px;" />
<img alt="../../../_images/sphinx-rtd-theme-110-screenshot3.png" class="align-right" src="../../../_images/sphinx-rtd-theme-110-screenshot3.png" style="width: 222.08px; height: 119.84px;" />
<p>In the engine room, we have ensured the long-term stability for users of this theme release by putting upper bounds on <code class="docutils literal notranslate"><span class="pre">Sphinx<6</span></code> and <code class="docutils literal notranslate"><span class="pre">docutils<0.18</span></code>.</p>
<p>We also fixed an issue that caused the theme to fail when Sphinx <code class="docutils literal notranslate"><span class="pre">5.2.0.post0</span></code> was released and will ensure that this doesn’t happen again.</p>
<p><a class="reference external" href="https://sphinx-rtd-theme.readthedocs.io/en/stable/changelog.html">Read the full changelog</a></p>
</section>
<section id="how-to-upgrade">
<h2>How to upgrade</h2>
<p>If you are using the theme for the first time, please refer the general <a class="reference external" href="https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html">installation instructions</a>.</p>
<p>For most projects, including projects hosted on Read the Docs, the general update instruction is to modify your project’s dependencies (often stored in <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code>) where you should add <code class="docutils literal notranslate"><span class="pre">sphinx-rtd-theme==1.1.0</span></code> (or replace any existing entries).</p>
<p>If you have a project on Read the Docs without a Python requirements file <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code>, you need to add one in order to use newer versions of sphinx-rtd-theme.
You can read more about adding a <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code> in our <a class="reference external" href="https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html" title="(in Read the Docs user documentation v10.15.0)"><span class="xref std std-doc">Documentation about Reproducible Builds</span></a>.</p>
</section>
<section id="upcoming-releases">
<span id="sphinx-rtd-theme110-upcoming-releases"></span><h2>Upcoming releases</h2>
<p>Each little change comes with an overhead of testing, perfection and a long list of legacy support. We are addressing all that in upcoming releases, so it will become less cumbersome to add new features. The building and testing processes are refined and future releases will drop some of the legacy.</p>
<p>Here are the highlights from our roadmap:</p>
<ul class="simple">
<li><p>sphinx-rtd-theme 1.2: <a class="reference external" href="https://github.com/readthedocs/readthedocs.org/pull/9665">Address jQuery removal from Sphinx</a>, <a class="reference external" href="https://github.com/readthedocs/readthedocs.org/pull/9665">adds docutils 0.18 support</a>, possibly also <a class="reference external" href="https://github.com/readthedocs/sphinx_rtd_theme/pull/1336">docutils 0.19 support</a></p></li>
<li><p>sphinx-rtd-theme 2.0: Adds Sphinx 6.x support, dropping legacy support for several Sphinx releases and old browsers.</p></li>
</ul>
<p>If you wish to see more details, <a class="reference external" href="https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#roadmap">view the full roadmap</a>.</p>
</section>
<section id="contributing">
<h2>Contributing</h2>
<p>If you experience any issues with the theme, we welcome you to visit the GitHub repository <a class="reference external" href="https://github.com/readthedocs/sphinx_rtd_theme/">readthedocs/sphinx-rtd-theme</a>.</p>
<p>For support questions, consider asking in one of the <a class="reference external" href="https://dev.readthedocs.io/en/latest/contribute.html#get-in-touch">Read the Docs community support channels</a>.</p>
</section>
</section>
We are happy to announce the release of new version of our theme, sphinx-rtd-theme.
In this release, we have focused on bug fixes, backwards compatibility, and making the way for future releases.Visually, we have a couple of small tweaks that most people won’t notice unless we mention them here 😇
The objective of the 1.1 release is to maintain backwards compatibility, and that also goes for the visual parts.2022-11-01T00:00:00+00:00