From 5d30f7e357efab185c25fe18301a82bdff137d93 Mon Sep 17 00:00:00 2001
From: Michael Boniface <m.j.boniface@soton.ac.uk>
Date: Mon, 10 Mar 2025 12:31:48 +0000
Subject: [PATCH] (docs) testing mkdocs and readthedocs integratino
---
pydoc-markdown.yml | 6 ------
pyproject.toml | 5 +----
readthedocs.yml | 17 -----------------
3 files changed, 1 insertion(+), 27 deletions(-)
delete mode 100644 pydoc-markdown.yml
delete mode 100644 readthedocs.yml
diff --git a/pydoc-markdown.yml b/pydoc-markdown.yml
deleted file mode 100644
index 4d41449..0000000
--- a/pydoc-markdown.yml
+++ /dev/null
@@ -1,6 +0,0 @@
-loaders:
- - type: python
- search_path: ["./acmc"]
-
-renderer:
- type: markdown
diff --git a/pyproject.toml b/pyproject.toml
index a883834..7cd62fe 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -77,15 +77,12 @@ dependencies = [
"mypy",
"pdoc",
"pydoc-markdown",
- "mkdocs",
- "mkdocs-material"
+ "mkdocs"
]
[tool.hatch.envs.dev.scripts]
format = "black ."
type = "mypy ."
-docs = "pydoc-markdown > docs/api.md"
-htmldocs = "pdoc -o docs/api -d markdown --docformat markdown --include-undocumented acmc"
precommit = "hatch run format && hatch run type && hatch run docs"
[tool.hatch.build]
diff --git a/readthedocs.yml b/readthedocs.yml
deleted file mode 100644
index 8b758a8..0000000
--- a/readthedocs.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-# Read the Docs configuration file for MkDocs projects
-
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-# Required
-version: 2
-
-# Set the version of Python and other tools you might need
-build:
- os: ubuntu-24.04
- tools:
- python: "3.12"
-
-mkdocs:
- configuration: mkdocs.yml
-
-
-
--
GitLab