From 832ddc1c4932a092e94c5aa7977d524706237ee3 Mon Sep 17 00:00:00 2001 From: Danny Colin Date: Sun, 28 Apr 2024 02:55:46 -0400 Subject: [PATCH] (no bug) Use sphinx-rtd-theme (#152) Gets us in compliance with ReadTheDocs best practices as well. --- .readthedocs.yaml | 9 ++++-- docs/en/images/bugzilla-logo-white.svg | 42 ++++++++++++++++++++++++++ docs/en/rst/_static/bugzilla.css | 24 +++------------ docs/en/rst/conf.py | 27 ++++++++++++++--- docs/requirements.txt | 3 ++ 5 files changed, 79 insertions(+), 26 deletions(-) create mode 100644 docs/en/images/bugzilla-logo-white.svg create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7eada0dd63..ff4cc83b48 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,8 +1,8 @@ version: 2 build: - os: "ubuntu-20.04" + os: "ubuntu-22.04" tools: - python: "3.10" + python: "3.11" apt_packages: - libfile-copy-recursive-perl jobs: @@ -10,3 +10,8 @@ build: - perl docs/makedocs.pl --pod-only - cp -rp docs/en/html/integrating/api/ "$READTHEDOCS_OUTPUT/html/integrating/api" - cp -p docs/en/html/style.css "$READTHEDOCS_OUTPUT/html/" +sphinx: + configuration: docs/en/rst/conf.py +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/en/images/bugzilla-logo-white.svg b/docs/en/images/bugzilla-logo-white.svg new file mode 100644 index 0000000000..e53952646f --- /dev/null +++ b/docs/en/images/bugzilla-logo-white.svg @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/en/rst/_static/bugzilla.css b/docs/en/rst/_static/bugzilla.css index 06f5c83752..8d1132f245 100644 --- a/docs/en/rst/_static/bugzilla.css +++ b/docs/en/rst/_static/bugzilla.css @@ -1,21 +1,5 @@ -@import 'default.css'; - -dt { font-weight: bold; } - -/* Custom roles */ -.param { font-weight: bold; } -.paramval { font-family: monospace; } -.group { font-family: monospace; } -.field { font-weight: bold; } -.command { font-family: monospace; font-size: 130% } - -.admonition-todo { - background-color: lightpink; - border: 2px darkred solid; -} - -/* Make Buggie's antenna not take up so much space */ -.logo { - display: block; - margin-top: -20px; +.wy-side-nav-search .wy-dropdown > a img.logo, +.wy-side-nav-search > a img.logo { + min-width: 150px; + width: 350px; } diff --git a/docs/en/rst/conf.py b/docs/en/rst/conf.py index b2bf9ec5e5..9169cb648f 100644 --- a/docs/en/rst/conf.py +++ b/docs/en/rst/conf.py @@ -128,12 +128,31 @@ them `here