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.

Sign up for GitHub

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

Jump to bottom

Added Sphinx ".. example::" container (analogous to Sphinx ".. doctest::" container) #796

Closed
trevorbaca opened this issue Jan 5, 2017 · 2 comments
Closed

Added Sphinx ".. example::" container (analogous to Sphinx ".. doctest::" container) #796

trevorbaca opened this issue Jan 5, 2017 · 2 comments
Labels
docs enhancement

Comments

@trevorbaca
Copy link
Member

When we write docstrings we tell Sphinx about doctest containers and example containers in two (very slightly different) ways.

Doctest markup:

..     doctest::

       >>> f(staff)

Example markup:

..     container:: example

       >>> f(staff)

It would be superclean if we could indicate examples like this:

..     example::

       >>> f(staff)
@trevorbaca
Copy link
Member Author

Still valid in June 2017.

@trevorbaca
Copy link
Member Author

Nice to have to not essential. Closing issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@trevorbaca