Updating RTD config.

OpenNTI · Dec 6, 2024 · 7f63395 · 7f63395
1 parent 0635fa7
commit 7f63395
Show file tree

Hide file tree

Showing 5 changed files with 123 additions and 14 deletions.
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -0,0 +1,95 @@
+/* Font definitions */
+@font-face {
+  font-family: 'JetBrains Mono';
+  src: url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff2/JetBrainsMono-Bold-Italic.woff2') format('woff2'),
+    url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff/JetBrainsMono-Bold-Italic.woff') format('woff');
+  font-weight: 700;
+  font-style: italic;
+  font-display: swap;
+}
+
+@font-face {
+  font-family: 'JetBrains Mono';
+  src: url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff2/JetBrainsMono-Bold.woff2') format('woff2'),
+    url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff/JetBrainsMono-Bold.woff') format('woff');
+  font-weight: 700;
+  font-style: normal;
+  font-display: swap;
+}
+
+@font-face {
+  font-family: 'JetBrains Mono';
+  src: url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff2/JetBrainsMono-ExtraBold-Italic.woff2') format('woff2'),
+    url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff/JetBrainsMono-ExtraBold-Italic.woff') format('woff');
+  font-weight: 800;
+  font-style: italic;
+  font-display: swap;
+}
+
+@font-face {
+  font-family: 'JetBrains Mono';
+  src: url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff2/JetBrainsMono-ExtraBold.woff2') format('woff2'),
+    url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff/JetBrainsMono-ExtraBold.woff') format('woff');
+  font-weight: 800;
+  font-style: normal;
+  font-display: swap;
+}
+
+@font-face {
+  font-family: 'JetBrains Mono';
+  src: url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff2/JetBrainsMono-Italic.woff2') format('woff2'),
+    url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff/JetBrainsMono-Italic.woff') format('woff');
+  font-weight: 400;
+  font-style: italic;
+  font-display: swap;
+}
+
+@font-face {
+  font-family: 'JetBrains Mono';
+  src: url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff2/JetBrainsMono-Medium-Italic.woff2') format('woff2'),
+    url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff/JetBrainsMono-Medium-Italic.woff') format('woff');
+  font-weight: 500;
+  font-style: italic;
+  font-display: swap;
+}
+
+@font-face {
+  font-family: 'JetBrains Mono';
+  src: url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff2/JetBrainsMono-Medium.woff2') format('woff2'),
+    url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff/JetBrainsMono-Medium.woff') format('woff');
+  font-weight: 500;
+  font-style: normal;
+  font-display: swap;
+}
+
+@font-face {
+  font-family: 'JetBrains Mono';
+  src: url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff2/JetBrainsMono-Regular.woff2') format('woff2'),
+    url('https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono/web/woff/JetBrainsMono-Regular.woff') format('woff');
+  font-weight: 400;
+  font-style: normal;
+  font-display: swap;
+}
+
+
+article {
+/* Furo theme makes this 1.5 which uses soo much space */
+    line-height: 1.1;
+}
+
+.admonition-opinion p.admonition-title {
+    background-color: rgba(255, 150, 235, 0.44);
+}
+
+div.admonition-opinion.admonition {
+    border-left: .2rem solid rgba(255, 150, 235, 0.44);
+}
+
+
+.admonition-design-options p.admonition-title {
+    background-color: rgba(173, 28, 237, 0.44);
+}
+
+div.admonition-design-options.admonition {
+    border-left: .2rem solid rgba(173, 28, 237, 0.44);
+}
diff --git a/docs/conf.py b/docs/conf.py
@@ -26,7 +26,7 @@
 
 import sphinxcontrib.programoutput as programoutput
 
-needs_sphinx = '1.0'
+needs_sphinx = '5.0'
 
 extensions = [
     'sphinx.ext.autodoc',
@@ -39,19 +39,30 @@
 source_suffix = '.rst'
 master_doc = 'index'
 
-project = u'sphinxcontrib-programoutput'
-copyright = u'2010, 2011, Sebastian Wiesner'
+project = 'sphinxcontrib-programoutput'
+copyright = '2010, 2011, Sebastian Wiesner'
 version = '.'.join(programoutput.__version__.split('.')[:2])
 release = programoutput.__version__
 
 exclude_patterns = ['_build/*']
 
-html_theme = 'default'
+html_theme = 'furo'
 html_static_path = []
 
+html_css_files = [
+    'custom.css',
+]
+
+html_theme_options = {
+    'light_css_variables': {
+        'font-stack': '"SF Pro",-apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji"',
+        'font-stack--monospace': '"JetBrainsMono", "JetBrains Mono", "JetBrains Mono Regular", "JetBrainsMono-Regular", ui-monospace, profont, monospace',
+    },
+}
+
 intersphinx_mapping = {
-    'python': ('https://docs.python.org', None),
-    'ansi': ('http://packages.python.org/sphinxcontrib-ansi', None)
+    'python': ('https://docs.python.org/', None),
+
 }
 
 extlinks = {

diff --git a/docs/index.rst b/docs/index.rst
@@ -291,7 +291,7 @@ but respect these guidelines:
   <https://gun.io/blog/how-to-github-fork-branch-and-pull-request/>`_.
 - Use a topic branch to easily amend a pull request later, if necessary.
 - Write `good commit messages
-  <http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
+  <https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
 - Squash commits on the topic branch before opening a pull request.
 - Respect :pep:`8` (use `pep8`_ to check your coding style compliance)
 - Add unit tests.
@@ -320,11 +320,11 @@ License
             directive with the ``prompt`` option set.
 
 
-.. _Sphinx: http://www.sphinx-doc.org/en/stable/
+.. _Sphinx: https://www.sphinx-doc.org/en/master/
 .. _PyPI: https://pypi.python.org/pypi/sphinxcontrib-programoutput
-.. _github: https://github.com/NextThought/sphinxcontrib-programoutput
-.. _readme: https://github.com/NextThought/sphinxcontrib-programoutput/blob/master/README.rst
+.. _github: https://github.com/OpenNTI/sphinxcontrib-programoutput
+.. _readme: https://github.com/OpenNTI/sphinxcontrib-programoutput/blob/master/README.rst
 .. _format string: https://docs.python.org/2/library/string.html#formatstrings
-.. _issue tracker: https://github.com/NextThought/sphinxcontrib-programoutput/issues
+.. _issue tracker: https://github.com/OpenNTI/sphinxcontrib-programoutput/issues
 .. _pep8: https://pypi.python.org/pypi/pep8/
-.. _MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#extended-block-tokens
+.. _MyST: https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html
diff --git a/setup.py b/setup.py
@@ -97,6 +97,7 @@ def read_version_number():
     extras_require={
         'test': tests_require,
         'docs': [
+            'furo',
         ],
     },
     python_requires=">=3.8",

diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist=py38,py39,310,311,312,313,pypy3,doc
+envlist=py38,py39,310,311,312,313,pypy3,docs
 
 [testenv]
 usedevelop = false
@@ -12,7 +12,9 @@ commands =
     coverage run -p -m zope.testrunner --test-path=src
 passenv = HOME
 
-[testenv:doc]
+[testenv:docs]
+extras =
+       docs
 commands =
     sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees docs {envtmpdir}/linkcheck
     sphinx-build -W -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html