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

Centralize text common to code and documentation (e.g., required python version numbers) #237

Open
rountree opened this issue May 8, 2024 · 0 comments
Assignees
Labels
docs Improvements or additions to documentation feature New feature or request

Comments

@rountree
Copy link
Collaborator

rountree commented May 8, 2024

We'd like to have the benchpark binary be able to check the version of python in use against the minimum version, mention the minimum version in the documentation, and both tied to a common source so there's only a single file that needs to get updated.

rst has a .. literalinclude:: tag that should fit the bill. Perhaps have a file ground_truth/min_python_version.txt that is included via literalinclude in the docs and (with a bit more work) parsed by python in the benchpark script.

This avoids any CI silliness.

@rountree rountree self-assigned this May 8, 2024
@rountree rountree added docs Improvements or additions to documentation feature New feature or request labels May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant