package
Version:
v0.1.4
Opens a new window with list of versions in this module.
Published: Jun 10, 2026
License: GPL-3.0
Opens a new window with license information.
Imports: 3
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
Documentation
¶
Package pydoc parses Python docstrings into structured DocComment values.
It auto-detects and supports three formats:
- Google style: Args:, Returns:, Raises:
- NumPy style: Parameters\n----------
- Sphinx style: :param name: desc, :type name: type
Format represents the detected docstring format.
const (
FormatGoogle Format = iota
FormatNumPy
FormatSphinx
FormatPlain
)
Parser implements docparser.Parser for Python docstrings.
New returns a new Python docstring parser.
Parse parses a Python docstring into a DocComment. It auto-detects the
format (Google, NumPy, or Sphinx) from the content.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.
