Shibuya Shibuya Shibuya
  • Examples
    • Admonitions Bring the attention of readers
    • Code Blocks Display code with highlights
    • Autodoc API documentation automatically
    • Jupyter Notebook Rendering .ipynb files
  • Branding
  • Sponsor me
  • Discussion

Getting started

  • Installation
  • Configuration
    • Logos
    • CSS Variables
    • Colors
    • Navbar links
    • Layouts
    • Announcement
    • Social network
    • Fonts
    • Sidebar
    • Languages
    • Advertisement
    • Icons
    • Markdown
  • Writing Guide
    • Markups
    • Block quotes
    • Lists
    • Tables
    • Admonitions
    • Code blocks
    • Math
    • Images and videos
    • API reference
    • Meta tags

Extensions

  • sphinx-copybutton
  • sphinx-design
  • sphinx-tabs
  • sphinx-togglebutton
  • jupyter-sphinx
  • nbsphinx
  • numpydoc
  • sphinxcontrib-mermaid
  • sphinx-docsearch
  • sphinx-click
  • sphinx-sqlalchemy
  • sphinx-contributors
  • sphinx-autoapi

Development

  • Contributing
    • Translations
    • Roadmap
  • Alternatives
  • Stability Policy
  • Changelog

On this page

  • Usage
lepture/shibuya 0 0
Edit this page
  1. Shibuya /
  2. sphinx-autoapi

sphinx-autoapi¶

Sphinx AutoAPI is a Sphinx extension for generating complete API documentation without needing to load, run, or import the project being documented.

  • Documentation: https://sphinx-autoapi.readthedocs.io/

  • Source Code: https://github.com/readthedocs/sphinx-autoapi

Usage¶

Install sphinx-autoapi:

pip install sphinx-autoapi

Add autoapi.extension to your conf.py:

extensions = [
    'autoapi.extension',
]
Previous
sphinx-contributors
Next
Contributing

Copyright © 2023, Hsiaoming Yang

Made with Sphinx and Shibuya theme.