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 Sphinx directives to include code _using tags_ #3316

Closed
JDBetteridge opened this issue Jan 10, 2024 · 0 comments · Fixed by #3405
Closed

DOCS: Use Sphinx directives to include code _using tags_ #3316

JDBetteridge opened this issue Jan 10, 2024 · 0 comments · Fixed by #3405
Assignees

Comments

@JDBetteridge
Copy link
Member

Describe the issue
Documentation currently uses line number references to include code snippets from the test suite (see, for example: https://github.com/firedrakeproject/firedrake/pull/3309/files). This is incredibly fragile to any edits made to the test suite. We should instead use

start-after/start-at/end-before/end-at

Sphinx directives, as documented here

Where to find

  • All over, but a good starting place would be docs/source/interpolation.rst

Additional info
Discussed in meeting 2024-01-10.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants