Python package documentation generation tool.
Note
This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the gallery for the big picture.
- pysphinxdoc.utils.examplify(filename, outfile)[source]ΒΆ
Read Python code from the file named by the first argument, and write an example as expected by sphinx gallery.
- Parameters:
filename : str
the file path with the Python code to read.
outfile : str
the destination file with the gallery example.
Follow us