
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
This package is under construction. A stable version should be release soon as 1.0.0
MDPyDoc is a powerful and flexible Python documentation generator that automatically creates markdown documentation from your Python source code. It analyzes the Abstract Syntax Tree (AST) of your Python files to extract docstrings, function signatures, and class structures, generating comprehensive and well-formatted documentation.
You can install MDPyDoc using pip:
pip install mdpydoc
You can use MDPyDoc either as a command-line tool or integrate it into your Python scripts.
python -m mdpydoc /path/to/source /path/to/docs --show-code --log-level DEBUG --max-workers 4
• src_directory: Source directory containing Python files
• docs_directory: Target directory for generated documentation
• --show-code: Include source code in documentation (optional)
• --log-level: Set the logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
• --max-workers: Maximum number of worker threads (positive integer or 'None')
from mdpydoc.doc_generator import DocGenerator
doc_generator = DocGenerator(
show_code=True,
log_level="INFO",
max_workers=4
)
doc_generator.process_directory("/path/to/source", "/path/to/docs")
MDPyDoc consists of several key components:
• DocGenerator: The main class that orchestrates the documentation generation process.
• MarkdownGenerator: Responsible for converting AST nodes into formatted Markdown.
• ASTParser: Parses the Abstract Syntax Tree of Python files.
• DocStringParser: Extracts and parses docstrings from AST nodes.
• FileProcessor: Processes individual Python files.
• AppLogger: A versatile logger.
MDPyDoc is designed to be extensible. You can customize the documentation generation process by subclassing and overriding methods in the MarkdownGenerator class.
Contributions to MDPyDoc are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
Thanks to all contributors who have helped to improve MDPyDoc. Special thanks to the Python community for providing excellent tools and libraries that made this project possible.
• Add support for generating documentation in different output formats (e.g., HTML, PDF)
• Implement a progress bar for large projects
• Add an option to exclude specific files or directories from documentation
• Implement cross-referencing between documented elements
• Add support for custom documentation templates
If you encounter any problems or have any questions, please open an issue on the GitHub repository.
FAQs
This package is under construction. A stable version should be release soon as 1.0.0
We found that mdpydoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.