{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/7"},{"label":"Code Generators","url":"https://skillfed.io/packages/category/software-development-code-generators"}],"enrichment":{"capability":"Pydoc-Markdown parses Python source code and generates API documentation in Markdown format, supporting multiple docstring styles and integrating with static site generators.","skillfed_tags":["api-docs","markdown-generation","static-site-integration"],"use_cases":["Generate API reference documentation for a Python library and commit it to version control alongside source code.","Integrate API documentation generation into a MkDocs or Hugo site build using Novella.","Convert existing docstrings in Sphinx or Google style to Markdown for a new documentation site.","Document variable assignments and module-level constants using docspec comment syntax.","Create a CI/CD step that regenerates and validates API docs on every commit."],"what_it_does":"Pydoc-Markdown is a command-line tool that reads Python source code and generates Markdown-formatted API documentation without executing the code. It parses docstrings in multiple styles (Sphinx, Google, Pydoc-Markdown) and converts them to properly formatted Markdown, making it useful for teams that want to keep API docs in version control alongside their source.\n\nThe tool supports configuration via YAML or pyproject.toml files and can integrate with static site generators like MkDocs and Hugo, either directly or through the Novella build backend. It understands variable docstrings through special comment syntax and generates cross-references between API objects. With 14 runtime dependencies including Jinja2, click, and docspec, it provides a complete pipeline from Python source to publishable documentation.","worth_installing":"Yes, if you need Markdown-based API documentation for Python projects. The tool is actively maintained, has no known vulnerabilities, and low install friction. Verify that the configuration style you plan to use (YAML, pyproject.toml, or Novella) is stable for your workflow before committing to it."},"id":"pydoc-markdown","links":{"html":"https://skillfed.io/packages/pydoc-markdown","md":"https://skillfed.io/packages/pydoc-markdown.md","pypi":"https://pypi.org/project/pydoc-markdown/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2023-06-26","license_spdx":null,"license_treatment":"permissive","name":"pydoc-markdown","python_support":"supports_current","summary":"Create Python API documentation in Markdown format."},"popularity":{"monthly_downloads":245261,"position":8736,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"4.8.2"}