View Source AutoDocPackage (auto_doc_package v0.1.1)

The package "AutoDocPackage" is used by the "Auto Doc" microservice for generating API documentation based on OpenApiSpex format for Elixir projects.

This package handles the transmission of data between the AutoDoc microservice and your Elixir project. It also generates the API Documentation directories and files filled with data, nested inside the respected /documentation directory.

Prerequisites

The package requires :jason and :httpoison to run while your project requires :open_api_spex as a documentation tool.

Installation

Add auto_doc_package to your list of dependencies in mix.exs:

  def deps do
    [
      {:auto_doc_package, "~> 0.1.1"}
    ]
  end

Extra Info

  • A complete guide on registration and usage can be found in our Github README.
  • The package is licensed under CC-BY-NC-ND-4.0.
  • The product "Auto Doc" is hosted at auto-doc.fly.dev.
  • The microservice itself works on a subscription basis.
  • The monthly subscription fee is 10€.
  • The product is currently in its initial phase and is being actively developed.

Modules