Merge pull request #5191 from rjbs/cyr-1472-strip-custom-sphinx-theme

docs: strip out custom theming and use stock RTD
cyrusimap · Jan 6, 2025 · 4808d5e · 4808d5e
2 parents 21bebcb + 3f7139a
commit 4808d5e
Show file tree

Hide file tree

Showing 70 changed files with 63 additions and 2,607 deletions.
diff --git a/docsrc/_static/cyrus.css b/docsrc/_static/cyrus.css
@@ -1,269 +1 @@
-a {
-    color: #1f8fc0;
-}
-
-a tt {
-    color: #1f8fc0;
-}
-
-a.internal em {
-    font-style: normal;
-}
-
-blockquote.epigraph div p {
-    font-style: italic;
-}
-
-body {
-    font-family: sans-serif;
-    letter-spacing: 0;
-}
-
-cite, code, pre, tt {
-    font-family: "Liberation Mono", "Consolas","Deja Vu Sans Mono","Bitstream Vera Sans Mono", monospace;
-}
-
-.rst-content code {
-    font-size: 90%;
-}
-
-div.admonition {
-    border-left: 0.5em solid #59bc00;
-    border-top: none;
-    border-right: none;
-    border-bottom: none;
-    margin-bottom: 1em;
-    padding-bottom: 0.5em;
-    padding-left: 1.5em;
-    padding-top: 0.5em;
-}
-
-div.admonition > div:last-child > *:last-child {
-    margin-bottom: 0;
-}
-
-div.admonition p {
-    margin: 1em 0 0.5em 0.5em;
-    padding: 0;
-}
-
-div.admonition p.admonition-title {
-    color: black;
-    margin: 1em 0 0.5em 0.5em;
-    padding: 0;
-    font-weight: bold;
-    display: block;
-    background-color: inherit;
-    border-bottom: none;
-}
-
-/* Green 'note' box */
-div.admonition.note {
-    border-left: 0.5em solid #59bc00;
-}
-
-div.admonition.important {
-    border-color: #ffc200;
-}
-
-div.admonition.warning {
-    border-color: #ff0000;
-}
-
-div.admonition.tip {
-    border-color: #1e90ff;
-}
-
-div.admonition-todo {
-    border-color: #cccccc;
-}
-
-div.admonition.caution {
-    border-color: #950000;
-}
-
-div.body a {
-    text-decoration: none;
-    color: #1F8FC0;
-}
-
-div.body h1, div.body h2, div.body h3 {
-    color: #002e50;
-}
-
-div.highlight {
-/*   border-left: 0.5em solid #666666; */
-    padding: 0;
-    margin: 1em 0 0.5em 0;
-}
-
-.highlight {
-	background: #eeeeee;
-}
-
-div.highlight pre {
-    border: 0px solid;
-    margin: 1em 0.5em 0.5em 0.5em;
-    padding-bottom: 0.5em;
-    padding-left: 1.5em;
-    padding-top: 0.5em;
-}
-
-div.linenodiv pre {
-    padding: 0.5em 0 0;
-}
-
-div.related {
-    background-color: #1F8FC0;
-}
-
-div.related ul li a {
-    color: white;
-}
-
-
-div.sphinxsidebar h3, div.sphinxsidebar h4 {
-    background-color: #002e50;
-    border: 1px solid white;
-    color: white;
-}
-
-div.sphinxsidebar h3 a {
-    color: white;
-}
-
-ol.arabic li {
-    margin-top: 0.5em;
-	line-height: 110%
-}
-
-nav.wy-nav-side p.caption {
-    font-style: italic;
-}
-
-nav.wy-nav-side p.caption-text {
-    font-size: 60%
-}
-
-nav.wy-nav-side p.caption {
-    font-size: 100%
-}
-
-/* For bold-italic and italic inside other formatting styles */
-/* ``command line `` :italic:`with italics`
- */
-
-.bolditalic {
-    font-weight: bold;
-    font-style: italic;
-}
-
-.italic {
-    font-style: italic;
-}
-
-.pageheader {
-    background-image: url(headimg.gif);
-    text-align: left;
-    padding: 10px 15px;
-}
-
-.pageheader ul {
-    float: right;
-    color: white;
-    list-style-type: none;
-    padding-left: 0;
-    margin-top: 30px;
-    margin-right: 10px;
-}
-
-.pageheader li {
-    float: left;
-    margin: 0 0 0 10px;
-}
-
-.pageheader li a {
-    border-radius: 1px;
-    padding: 8px 12px;
-    color: #f9f9f0;
-    text-shadow: 0 0 5px rgba(0, 0, 0, 0.5);
-}
-
-.pageheader li a:hover {
-    background-color: #f9f9f0;
-    color: #0a507a;
-    text-shadow: none;
-}
-
-.wy-nav-content {
-    max-width: 100%
-}
-
-.wy-nav-side {
-    background-color: #2d9dcb;
-    color: white;
-}
-
-.wy-nav-side li a {
-    color: white;
-}
-
-.wy-side-nav-search {
-    background-color: #2d9dcb;
-}
-
-.wy-side-nav-search a img {
-        margin-bottom: 0px;
-}
-
-.wy-side-nav-search a:hover {
-    background-color: #2d9dcb;
-}
-
-.wy-side-nav-search img {
-    border-radius: initial;
-    width: 100%;
-    height: 100%;
-    background-color: #2d9dcb;
-}
-
-.wy-table-responsive table td, .wy-table-responsive table th {
-    white-space: normal;
-}
-
-h4 {
-    font-style: italic;
-}
-
-.rst-content .sidebar {
-    width: 35%;
-    padding-bottom: 0px;
-    font-size: 80%;
-}
-
-.rst-content .sidebar {
-    margin-bottom: 0px;
-    line-height: 18px;
-}
-
-.rst-content .sidebar blockquote {
-    margin-bottom: 0px;
-    margin-left: 0px;
-    padding-left: 0px;
-    line-height: 18px;
-}
-
-.rst-content .sidebar p {
-    line-height: 18px;
-}
-
-div.buildstatus {
-    position: fixed;
-    bottom: 10px;
-    left: 10px;
-    font-size: 80%;
-}
-
-div.buildstatus a:visited {
-    color: white;
-}
+/* This file is empty, but maybe someday it will not be empty. */
diff --git a/docsrc/conf.py b/docsrc/conf.py
@@ -146,7 +146,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-html_theme = 'cyrus'
+html_theme = 'sphinx_rtd_theme'
 
 html_context = {
   "display_github": True, # Add 'Edit on Github' link instead of 'View page source'
@@ -163,7 +163,7 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = { 'github_version': 'master'}
+html_theme_options = { }
 
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -527,8 +527,8 @@
 # XXX handlers here, except that these urls require expanding the version string
 # XXX twice, and the sphinx extlinks thingy currently only supports a single %s
 extlinks = {
-        'draft':('https://tools.ietf.org/html/%s', ''),
-        'issue':('https://github.com/cyrusimap/cyrus-imapd/issues/%s', 'Issue #'),
+        'draft':('https://tools.ietf.org/html/%s', '%s'),
+        'issue':('https://github.com/cyrusimap/cyrus-imapd/issues/%s', 'Issue #%s'),
         'cyrus-2.5':('https://www.cyrusimap.org/2.5%s',None),
         'cyrus-3.0':('https://www.cyrusimap.org/3.0%s',None),
         'cyrus-3.2':('https://www.cyrusimap.org/3.2%s',None),
@@ -541,7 +541,7 @@
         'cyrus-stable': ('https://www.cyrusimap.org%s',None),
         'github-release':
             ('https://github.com/cyrusimap/cyrus-imapd/releases/tag/cyrus-imapd-%s',
-             'cyrus-imapd-'),
+             'cyrus-imapd-%s'),
     }
 
 # Change this to whatever your output root is

diff --git a/docsrc/exts/themes/cyrus/__init__.py b/docsrc/exts/themes/cyrus/__init__.py
diff --git a/docsrc/exts/themes/cyrus/breadcrumbs.html b/docsrc/exts/themes/cyrus/breadcrumbs.html
diff --git a/docsrc/exts/themes/cyrus/buildstatus.html b/docsrc/exts/themes/cyrus/buildstatus.html
diff --git a/docsrc/exts/themes/cyrus/footer.html b/docsrc/exts/themes/cyrus/footer.html