Fix RTD builds

RadioAstronomySoftwareGroup · Aug 10, 2023 · dae917d · dae917d
1 parent 81d30d5
commit dae917d
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 12 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -7,17 +7,22 @@ version: 2
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
+  builder: html
   configuration: docs/conf.py
+# might want to do this in future:
+  # fail_on_warning: true
 
 # Do not build the docs in additional formats (e.g. PDF and ePub), use default
 formats: []
 
+# Set the version of Python and other tools you might need
 build:
-    image: latest
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
 
-# Optionally set the version of Python and requirements required to build your docs
+# Optionally install options and requirements required to build your docs
 python:
-  version: 3.8
   install:
     - method: pip
       path: .

diff --git a/docs/conf.py b/docs/conf.py
@@ -60,6 +60,7 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
     "sphinx.ext.intersphinx",
+    "sphinx_rtd_theme",
 ]
 # set this to properly handle multiple input params with the same type/shape
 napoleon_use_param = False
@@ -91,9 +92,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
-# html_theme = 'alabaster'
-html_theme = "default"
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
-sphinx>=1.3
-sphinx_rtd_theme==0.5.2
+sphinx>=6.2
+sphinx_rtd_theme==1.2.2
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -216,12 +216,11 @@ a) using extended_model_group attribute
     :width: 600
 
 b) using stokes_error attribute, changing component type
-******************************************************
+********************************************************
 .. code-block:: python
 
   >>> import os
   >>> from pyradiosky import SkyModel
-  >>> from pyradiosky import utils
   >>> import matplotlib.pyplot as plt # doctest: +SKIP
   >>> sm = SkyModel()
 
@@ -752,7 +751,7 @@ SkyModel: Concatenating data
 ------------------------------------------
 
 a) using select and concat methods
-*******
+**********************************
 .. code-block:: python
 
   >>> import os

diff --git a/docs/utility_functions.rst b/docs/utility_functions.rst
@@ -1,5 +1,5 @@
 Utility Functions
 =================
 
-.. automodule:: utils
+.. automodule:: pyradiosky.utils
   :members: