From 24f6a948a4175361b4d16e1e2614c4d9c5dc9d2a Mon Sep 17 00:00:00 2001
From: Michael Boniface <m.j.boniface@soton.ac.uk>
Date: Mon, 10 Mar 2025 12:01:19 +0000
Subject: [PATCH] (docs) testing mkdocs and readthedocs integratino
---
pyproject.toml | 5 ++---
readthedocs.yml | 6 +++++-
2 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/pyproject.toml b/pyproject.toml
index 0feecc1..a883834 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -64,11 +64,10 @@ dependencies = [
"pytest",
]
-[tool.hatch.envs.documentation]
+[tool.hatch.envs.docs]
dependencies = [
"mkdocs",
- "mkdocs-material",
- "mkdocs-rtd-theme"
+ "mkdocs-material"
]
[tool.hatch.envs.dev]
diff --git a/readthedocs.yml b/readthedocs.yml
index 3b35eef..d3b1499 100644
--- a/readthedocs.yml
+++ b/readthedocs.yml
@@ -9,6 +9,10 @@ build:
os: ubuntu-24.04
tools:
python: "3.12"
+ command:
+ - pip install hatch # Manually install hatch
+ - hatch shell docs
+ - mkdocs build
mkdocs:
configuration: mkdocs.yml
@@ -17,7 +21,7 @@ mkdocs:
python:
install:
- - method: hatch
+ - method: pip
path: .
--
GitLab