Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: use the right ops-scenario for building the docs #1470

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tonyandrewmeyer
Copy link
Contributor

This PR fixes the version of ops-scenario used when building the docs.

Previously, the published version of ops-scenario was used for generating the documentation, and the generated requirements file was used for local builds but not for read-the-docs.

That breaks if there are local incompatible changes (such as renaming a module), and is generally wrong anyway.

With this PR, the local version is loaded, and read-the-docs uses the same requirements file as building locally. A few minor type annotations were adjusted to remove remaining warnings (I don't know why Sphinx couldn't figure out where Path was coming from, but keeping it in the pathlib namespace is generally nicer anyway).

Split out from #1467.

testing/src/scenario/state.py Show resolved Hide resolved
testing/src/scenario/state.py Show resolved Hide resolved
tox.ini Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants