139 custom theme

docs/_static/furo_custom.css

@@ -0,0 +1,27 @@
+table.docutils {
+  font-size: 85%;
+}
+
+.admonition {
+  border-color: #aa2b5c;
+}
+
+p.admonition-title {
+  background-color: #BB437F4F;
+}
+
+p.admonition-title::before {
+  background-color: #aa2b5c;
+}
+
+table.docutils th {
+  background: transparent;
+}
+
+tr.row-even {
+  background-color: var(--color-background-secondary);
+}
+
+.docson .box {
+  background-color: rgb(255, 255, 255);
+}

docs/conf.py

@@ -33,8 +33,7 @@
 extensions = ['myst_parser',
 'sphinxcontrib.opendataservices',
 'sphinxcontrib.jsonschema',
-'sphinx_design',
-'sphinx_rtd_theme']
+'sphinx_design']
 
 #MyST extenions
 myst_enable_extensions = [
@@ -138,23 +137,40 @@
 import os
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
 
 # otherwise, readthedocs.org uses their theme by default, so no need to specify it
 
 # 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 = {'navigation_depth': 5}
+html_theme_options = {
+  'light_css_variables': {
+    'color-brand-primary': '#aa2b5c',
+    'color-brand-content': '#aa2b5c',
+    'color-background-secondary': '#FAF8F9',
+    'color-sidebar-brand-text': '#aa2b5c'
+  },
+  'dark_css_variables': {
+    'color-brand-primary': '#da8ba9',
+    'color-brand-content': '#da8ba9',
+    'color-sidebar-brand-text': '#da8ba9'
+  },
+  "light_logo": "ods_logo_light.png",
+  "dark_logo": "ods_logo_dark.png"
+}
+
+pygments_style = "perldoc"
+pygments_dark_style = "dracula"
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = 'Open Data Services Sphinx Base'
+html_title = 'Open Fibre Data Standard'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #
@@ -163,7 +179,6 @@
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-# html_logo = None
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -176,6 +191,8 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static', '../schema']
 
+html_css_files = ['furo_custom.css']
+
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.

docs/reference/publication_formats/csv.md

@@ -10,12 +10,7 @@ To comment on or create discussions and issues, you need to [sign up for a free
 
 This section describes the structure of the tables in the CSV format and the relationship between the tables. Example CSV files and blank templates are provided for each table.
 
-The CSV format consists of several tables, reflecting the structure of the [schema](../schema.md). The networks table is the main table. Arrays of objects in the schema are represented as separate tables:
-
-```{contents}
----
-local: true
-```
+The CSV format consists of several tables, reflecting the structure of the [schema](../schema.md). The [networks table](#networks) is the main table. Arrays of objects in the schema are represented using the tables listed in the right sidebar.
 
 The field in the schema that each column represents is identified by the field's [JSON Pointer](https://tools.ietf.org/html/rfc6901). Rows in child tables are related to rows in parent tables using the parent object's `id` field.
 

requirements.in

@@ -4,7 +4,6 @@ sphinxcontrib-opendataservices
 sphinxcontrib-opendataservices-jsonschema
 sphinx-intl
 transifex-client
-sphinx_rtd_theme
 myst-parser
 sphinx-autobuild
 pyairtable
@@ -17,3 +16,4 @@ pytest
 jscc
 mdformat
 jsonschema
+furo

requirements.txt

@@ -20,6 +20,8 @@ babel==2.10.3
     #   sphinx-intl
 backports-datetime-fromisoformat==1.0.0
     # via flattentool
+beautifulsoup4==4.11.1
+    # via furo
 btrees==4.10.1
     # via zodb
 cattrs==22.1.0
@@ -46,7 +48,6 @@ docutils==0.17.1
     # via
     #   myst-parser
     #   sphinx
-    #   sphinx-rtd-theme
     #   sphinxcontrib-opendataservices
     #   sphinxcontrib-opendataservices-jsonschema
 et-xmlfile==1.1.0
@@ -57,6 +58,8 @@ exceptiongroup==1.0.0rc9
     #   pytest
 flattentool==0.20.0
     # via -r requirements.in
+furo==2022.12.7
+    # via -r requirements.in
 gitdb==4.0.9
     # via gitpython
 gitpython==3.1.27
@@ -156,7 +159,9 @@ pycparser==2.21
 pygithub==1.55
     # via -r requirements.in
 pygments==2.12.0
-    # via sphinx
+    # via
+    #   furo
+    #   sphinx
 pyjwt==2.4.0
     # via pygithub
 pynacl==1.5.0
@@ -205,23 +210,26 @@ smmap==5.0.0
     # via gitdb
 snowballstemmer==2.2.0
     # via sphinx
-sphinx==4.5.0
+soupsieve==2.3.2.post1
+    # via beautifulsoup4
+sphinx==5.3.0
     # via
     #   -r requirements.in
+    #   furo
     #   myst-parser
     #   sphinx-autobuild
+    #   sphinx-basic-ng
     #   sphinx-design
     #   sphinx-intl
-    #   sphinx-rtd-theme
     #   sphinxcontrib-opendataservices
 sphinx-autobuild==2021.3.14
     # via -r requirements.in
+sphinx-basic-ng==1.0.0b1
+    # via furo
 sphinx-design==0.3.0
     # via -r requirements.in
 sphinx-intl==2.0.1
     # via -r requirements.in
-sphinx-rtd-theme==1.0.0
-    # via -r requirements.in
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
 sphinxcontrib-devhelp==1.0.2