Generate project documentation using GPT.
Project description
create_doc
Generate angular project documentation using GPT and dependency-cruiser.
- Free software: MIT license
Features
-
Create documentation for your project using GPT. Analyze html files or other file types and generate a markdown file with the documentation.
-
Create module dependency documentation using dependency-cruiser static code analysis.
Usage
-
Initialize a project with the following command:
create_doc init
-
Create documentation for your project html files with the following command:
create_doc process_html
-
Create documentation for your project dependencies with the following command:
create_doc process_dependencies
Credits
This package was created with Cookiecutter_ and the audreyr/cookiecutter-pypackage
_ project template.
- Cookiecutter: https://github.com/audreyr/cookiecutter
audreyr/cookiecutter-pypackage
: https://github.com/audreyr/cookiecutter-pypackage
Example angular form from https://github.com/gothinkster/angular-realworld-example-app
History
0.1.0 (2023-03-25)
- First release on PyPI.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for create_doc-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c37b49ae1bdbdebd173e2da71a0edfe51a030b4bdc12917016dd25d0c6bde3e7 |
|
MD5 | e6ae68e64c8c7b7facdec8fb04962d28 |
|
BLAKE2b-256 | 5f6fa2d4bcc01496411bc9b8250d9e422dfe52e3f397ae32c64b04a80f2007be |