docs: add ReadTheDocs configuration; fix mkdocstrings source path - #9
Merged
Conversation
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 <noreply@anthropic.com>
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 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
.readthedocs.yaml(mkdocs build, installs.[doc]) so DDSim docs can join the SINAPSE SDK's ReadTheDocs setup, mirroring rhapsody/asyncflow.