Skip to content
Snippets Groups Projects
Commit 5d30f7e3 authored by mjbonifa's avatar mjbonifa
Browse files

(docs) testing mkdocs and readthedocs integratino

parent e2dd5288
No related branches found
No related tags found
No related merge requests found
loaders:
- type: python
search_path: ["./acmc"]
renderer:
type: markdown
......@@ -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]
......
# 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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment