Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
NeuroPlot
Logo
NeuroPlot
  • Installation
  • Getting Started
  • User Guide
    • 1. 10 minutes to NeuroPlot
    • 2. Plotting a 3D image
    • 3. Multiple plots
    • 4. Making a GIF
  • Examples
    • Plot a 3D image
  • API Reference
    • neuroplot.plot: Plotting neuroimages
      • neuroplot.plot.single.SinglePlot
      • neuroplot.plot.single.GIF
      • neuroplot.plot.multiple.MultiplePlot
    • neuroplot.transforms: Transforming images before plotting
      • neuroplot.transforms.Noise
      • neuroplot.transforms.RescaleIntensity
  • Glossary

development

  • Contributing
  • GitHub

tutorial

  • Documentation tutorial
    • 1. Getting started with Sphinx
    • 2. Write documentation pages
    • 3. Configure your Sphinx documentation
    • 4. Automatically build an API Reference with Sphinx
      • 4.1. Writing docstrings
      • 4.2. Parsing docstrings with Sphinx
      • 4.3. Going further with autosummary
    • 5. Deploy your documentation
      • 5.1. GitHub Pages
      • 5.2. Read the Docs
    • 6. Bonus
      • 6.1. Generate an example gallery
      • 6.2. Build a glossary
      • 6.3. Manage references with Sphinx
      • 6.4. Manage external links
Back to top
View this page

4. Automatically build an API Reference with SphinxΒΆ

In this section we will see how to automatically build our API Reference from our Python docstrings.

  • 4.1. Writing docstrings
  • 4.2. Parsing docstrings with Sphinx
  • 4.3. Going further with autosummary
Next
4.1. Writing docstrings
Previous
3. Configure your Sphinx documentation
Copyright © 2025, ARAMIS Lab
Made with Sphinx and @pradyunsg's Furo