xcribe

0.0.2

0.7.12 0.7.11 0.7.10 0.7.9 0.7.8 0.7.7 0.7.6 0.7.5 0.7.4 0.7.3 0.7.2 0.7.1 0.7.0 0.6.1 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.1 0.1.0 0.0.2 0.0.1

A lib to generate API documentation from test specs

HexDocs

Current section

Files

Jump to

Readme 23 Versions 0 Dependencies Dependants Files Activity

xcribe lib config.ex

Raw

lib/config.ex

defmodule Xcribe.Config do
  def output_file, do: Application.get_env(:xcribe, :output_file, "api_doc.apib")

  def active?, do: !is_nil(System.get_env(env_var_name()))

  def xcribe_information_source,
    do: Application.fetch_env!(:xcribe, :information_source)

  defp env_var_name, do: Application.get_env(:xcribe, :env_var, "XCRIBE_ENV")
end

Search filters

Type any of these into the search box. They can be combined with free text which searches package names and descriptions.

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT

Wrap values in double quotes to include spaces, e.g. name:"my package".