add file with sphinx requirements for building doc.

rouilj · rouilj · commit 74e60eafbed0 · 2023-06-15T20:46:59.000-04:00
Disable permalinks for older and newer sphinx versions.

make conf.py's work with old and new sphinx.

make layout.py work with 7.x sphinx which replaces the style
variable with styles[].
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
@@ -73,14 +73,30 @@ <h3>{{ _('Quick search') }}</h3>
 {%- endmacro %}
 
 {%- macro css() %}
-    <link rel="stylesheet" href="{{ pathto('_static/basic.css', 1) }}" type="text/css" />
-    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
+    <link rel="stylesheet" href="{{ pathto('_static/NO_basic.css', 1) }}" type="text/css" />
+    <link rel="stylesheet" href="{{ pathto('_static/' + styles[-1], 1) }}" type="text/css" />
     <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
     {%- for cssfile in css_files %}
     <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
     {%- endfor %}
 {%- endmacro %}
 
+{#
+ In newer sphinx styles is an array and style does not exist
+ In older sphinx (1.x) style is the style set in conf.py.
+
+ If style exists, assume styles doesn't exist and make styles
+ exist with style as the only value.
+
+ So we can use styles[-1] in the css() macro.
+ When sourceforge lets me build docs with something newer than sphinx 1,
+ we can delete this.
+#}
+{% if style %}
+{% set styles = [] %}
+{{ styles.append( style ) }}
+{% endif %}
+
 <html lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/doc/conf.py b/doc/conf.py
@@ -84,7 +84,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -117,6 +117,10 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+# disable permalinks
+html_add_permalinks = ''
+html_permalinks = False  # when sphinx > 3.5 is used.
+
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
diff --git a/website/www/conf.py b/website/www/conf.py
@@ -168,7 +168,9 @@
 # template names.
 #html_additional_pages = {}
 
+# disable permalinks
 html_add_permalinks = ''
+html_permalinks = False  # when sphinx > 3.5 is used.
 
 # If false, no module index is generated.
 #html_use_modindex = True
diff --git a/website/www/requirements.pip b/website/www/requirements.pip
@@ -0,0 +1 @@
+sphinx_sitemap
