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

wrong documentation in directives.rst #11407

Closed
generationext opened this issue May 6, 2023 · 3 comments
Closed

wrong documentation in directives.rst #11407

generationext opened this issue May 6, 2023 · 3 comments

Comments

@generationext
Copy link

Describe the bug

In file sphinx/doc/usage/restructuredtext/directives.rst

Useful cases of these option is working with tag comments.
:start-after: [initialized] and :end-before: [initialized] options
keep lines between comments:

  .. code-block:: py

     if __name__ == "__main__":
         # [initialize]
         app.start(":8000")
         # [initialize]

[initialized] or [initialize] ?

How to Reproduce

.. literalinclude:: src/foo.py
:start-after: [initialized]
:end-before: [initialized]

start-after pattern not found: [initialized]

Environment Information

documentation

Sphinx extensions

No response

Additional context

No response

@jfbu jfbu added the type:docs label May 7, 2023
@jfbu
Copy link
Contributor

jfbu commented May 7, 2023

Thanks, if you have time, please contribute a PR to fix this (choose anyone of the variants). Relates #7997.

@blaisep
Copy link
Contributor

blaisep commented Jul 25, 2023

Hi @generationext , I think I got what you were looking for here #11513

@blaisep
Copy link
Contributor

blaisep commented Jul 29, 2023

@jfbu , I think you can easily rebase this onto the latest
I believe this will close the issue.

@jfbu jfbu closed this as completed in b0fe730 Jul 30, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants