Merge pull request #201 from crazyscientist/187-rtd-pickle-error

Docs: Updates

.readthedocs.yaml

@@ -3,12 +3,12 @@
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 version: 2
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "3.12"
 sphinx:
   configuration: doc/source/conf.py
 python:
   install:
-  - requirements: requirements.txt
-  - requirements: requirements_devel.txt
+    - requirements: requirements.txt
+    - requirements: requirements_devel.txt

doc/source/conf.py

@@ -41,7 +41,8 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.viewcode',
+    # Disabling the extension because of https://github.com/sphinx-doc/sphinx/issues/13095
+    # 'sphinx.ext.viewcode',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -131,8 +132,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'OSCTiny.tex', 'OSC Tiny Documentation',
-     'Andreas Hasenkopf', 'manual'),
+    (master_doc, 'OSCTiny.tex', project + ' Documentation',
+     author, 'manual'),
 ]
 
 
@@ -141,7 +142,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'osctiny', 'OSC Tiny Documentation',
+    (master_doc, 'osctiny', project + ' Documentation',
      [author], 1)
 ]
 
@@ -152,8 +153,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'OSCTiny', 'OSC Tiny Documentation',
-     author, 'OSCTiny', 'One line description of project.',
+    (master_doc, project, project + ' Documentation',
+     author, project, 'One line description of project.',
      'Miscellaneous'),
 ]