Skip to main content

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.

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

create_doc-0.1.1.tar.gz (19.4 kB view hashes)

Uploaded Source

Built Distribution

create_doc-0.1.1-py2.py3-none-any.whl (9.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page