From cdc99dfd69d3144f3ba31e971c346c7e4fecc1ee Mon Sep 17 00:00:00 2001 From: Andre Merzky Date: Tue, 25 Aug 2026 02:09:27 +0200 Subject: [PATCH 1/2] docs: add ReadTheDocs configuration; fix mkdocstrings source path RTD builds mkdocs on ubuntu-24.04/py3.12, installing the package plus the doc extra so mkdocstrings can import ddsim. mkdocstrings pointed at a nonexistent src/ dir (flat layout) - API autodoc resolved nothing; it now scans the repo root. Co-Authored-By: Claude Fable 5 --- .readthedocs.yaml | 16 ++++++++++++++++ mkdocs.yml | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3310942 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,16 @@ +version: 2 + +build: + os: ubuntu-24.04 + tools: + python: "3.12" + +mkdocs: + configuration: mkdocs.yml + +python: + install: + - method: pip + path: . + extra_requirements: + - doc diff --git a/mkdocs.yml b/mkdocs.yml index 6710736..d0ea554 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,7 +45,7 @@ plugins: - mkdocstrings: handlers: python: - paths: [src] + paths: ["."] options: docstring_style: google show_source: true From f005f5f6a78b376bf9c407b33732dcae353c07c1 Mon Sep 17 00:00:00 2001 From: Andre Merzky Date: Tue, 25 Aug 2026 11:36:46 +0200 Subject: [PATCH 2/2] lint: satisfy ruff's markdown code-snippet formatting Unpinned ruff in the dev extra moved forward; current ruff also formats python snippets inside markdown, which turned CI red on unchanged code. Co-Authored-By: Claude Fable 5 --- CONTRIBUTING.md | 16 ++++++---------- README.md | 2 +- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07f43a5..863b277 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -202,6 +202,7 @@ To create a custom workflow, extend `DDMD_manager`: ```python from ddmd import DDMD_manager + class MyWorkflow(DDMD_manager): def __init__(self, asyncflow, **kwargs): super().__init__(asyncflow) @@ -212,20 +213,15 @@ class MyWorkflow(DDMD_manager): pass # Implement required abstract methods - def stop_simulation(self, prediction): - ... + def stop_simulation(self, prediction): ... - async def init_sim_queue(self): - ... + async def init_sim_queue(self): ... - async def check_train_data(self): - ... + async def check_train_data(self): ... - async def train_model(self): - ... + async def train_model(self): ... - async def clean_sim_data(self, sim_ind): - ... + async def clean_sim_data(self, sim_ind): ... ``` ## Questions? diff --git a/README.md b/README.md index 55087c7..1ef373c 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ class DDMdWrapperWorkflow(BaseWorkflow): asyncflow=self.asyncflow, config=replica_config_path, name=replica_id.replace("_", ""), - on_ready=lambda: self._signal_done(), # ← CM hook + on_ready=lambda: self._signal_done(), # ← CM hook policies=self.policies, engine_dragon=self.engine_dragon, )