Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
pysphinxdoc 2.0.0 documentation
Logo
pysphinxdoc 2.0.0 documentation
  • Quickstart
  • Examples
    • Basic example on how to generate a package documentation
  • User guide
    • 1. What is pysphinxdoc
    • 2. Requirements
    • 3. First step with pysphinxdoc
  • API References
    • pysphinxdoc.docgen: Provide a ‘DocHelperWriter’ class to generate a Sphinx complient
      • pysphinxdoc.docgen.DocWriter
    • pysphinxdoc.interface: Provide a command line interface.
      • pysphinxdoc.interface.generate_documentation
      • pysphinxdoc.interface.generate_documentation_main
    • pysphinxdoc.utils: Provide usefull functions.
      • pysphinxdoc.utils._getmembers
      • pysphinxdoc.utils.getmembers
  • API Search

Development

  • Contributing
  • Continuous integration
  • Maintenance
  • Changelog
  • People
  • License
  • Versions
Back to top
View this page
Edit this page

Examples¶

Basic example on how to generate a package documentation

Basic example on how to generate a package documentation

Download all examples in Python source code: auto_examples_python.zip

Download all examples in Jupyter notebooks: auto_examples_jupyter.zip

Gallery generated by Sphinx-Gallery

Next
Basic example on how to generate a package documentation
Previous
Quickstart
Copyright © The pysphinxdoc developers.
Made with Sphinx and @pradyunsg's Furo