3

I would like to provide code snippets to show-case how one could use a particular method or class in python. How can I do that?

In Java one could use <pre> ... </pre> to do so.

Doctest is the only way? As I look at the existing docstrings for typical packages (e.g., pandas, numpy, etc), I never see anything other than doctest which is intended to test the method and not just to format text as python code. So, if doctest is the only way, what would be the proper way of formatting a snippet of code to look like interactive python sessions? I don't want to write my code in an interactive session each time and then c+p it in my docstring. It doesn't seem to be right.

Azim
  • 1,596
  • 18
  • 34

1 Answers1

5

DocStrings are not the only way. If you are using Sphinx to generate documentation then you should read this.

Example

Here is something I want to talk about:: <-- Special syntax to mark code beginning

    def my_fn(foo, bar=True): # Code itself
        """A really useful function.

        Returns None
        """
fizzybear
  • 1,197
  • 8
  • 22
  • 1
    This is nice. But if possible at all, I prefer to prevent the documentation to depend on another package. – Azim Jul 04 '19 at 18:25
  • Just noticed that `::` works without needing any package installed. So, I am going to accept you answer. – Azim Jul 04 '19 at 22:01