Description:
AutoDoc is an open-source Application made with Python that automates the document creation process by extracting information from code and generating documentation in markdown format. Whether you need to update API docs, write comprehensive reports, or generate internal documentation, AutoDoc simplifies the process.
[THIS PROJECT IS STILL IN VERY EARLY DEVELOPMENT STAGES DO NOT SOLELY RELY ON THE DOCUMENTATION GENERATED BY THIS APPLICATION]
Features:
- Extracts documentation comments from your code.
- Generates documentation in markdown.
- Supports common documentation styles and conventions.
- Allows customization of the documentation generation process.
Screenshots:
[Image of AutoDoc documentation preview]
Contributing Guidelines:
We welcome contributions to enhance AutoDoc! Please refer to the CONTRIBUTING.md file for guidelines.
License:
AutoDoc is licensed under the MIT License, allowing for both commercial and non-commercial use.
Contact Information:
For inquiries or feedback, please reach out to:
- GitHub Issues: https://github.com/manavvgarg/AutoDoc/issues
- Email: [email protected]
Additional Files:
.env: Environment variables for the project..gitattributes: Defines how to handle certain file types in Git..gitignore: Specifies files and directories to exclude from Git version control.
Explore the source code and contribute to this documentation-generating powerhouse!
Documentation Generated by AutoDoc | 2024