From 57334bd75875068b7452b08001e4897922dace47 Mon Sep 17 00:00:00 2001
From: Adam Reeve <adreeve@gmail.com>
Date: Tue, 12 Sep 2023 11:01:52 +1200
Subject: [PATCH] Fix building the documentation on readthedocs (#310)

---
 .readthedocs.yaml | 11 ++++++++---
 docs/conf.py      | 14 +++++++-------
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 404510d..b5c4be8 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,11 +1,16 @@
 version: 2
 
-# Build from the docs/ directory with Sphinx
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
 sphinx:
   configuration: docs/conf.py
+  fail_on_warning: true
 
-# Explicitly set the version of Python and its requirements
 python:
-  version: 3.8
   install:
     - requirements: docs/requirements.txt
+    - method: pip
+      path: .
diff --git a/docs/conf.py b/docs/conf.py
index dccd495..11d26e2 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -11,13 +11,13 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import sys
 import configparser
+from pathlib import Path
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('..'))
+# Allow importing nptdms from the parent directory for building API docs
+repo_root = Path(__file__).parent.parent
+sys.path.insert(0, str(repo_root))
 
 # -- General configuration -----------------------------------------------------
 
@@ -45,14 +45,14 @@
 
 # General information about the project.
 project = u'npTDMS'
-copyright = u'2012, Adam Reeve'
+copyright = u'Adam Reeve'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 setup_cfg = configparser.ConfigParser()
-setup_cfg.read('../setup.cfg')
+setup_cfg.read(repo_root / 'setup.cfg')
 # The short X.Y version.
 version = '.'.join(setup_cfg['metadata']['version'].split('.')[:2])
 # The full version, including alpha/beta/rc tags.