https://github.com/danilamihailov/docs_getter

Build docs for all dependencies
https://github.com/danilamihailov/docs_getter

docs elixir elixir-lang mix

Last synced: about 1 month ago
JSON representation

Build docs for all dependencies

• Host: GitHub
• URL: https://github.com/danilamihailov/docs_getter
• Owner: DanilaMihailov
• License: apache-2.0
• Created: 2020-02-11T18:09:05.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-13T10:18:28.000Z (almost 5 years ago)
• Last Synced: 2024-11-13T17:11:49.740Z (about 1 month ago)
• Topics: docs, elixir, elixir-lang, mix
• Language: Elixir
• Homepage:
• Size: 204 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DocsGetter [![Hex Version](https://img.shields.io/hexpm/v/docs_getter.svg)](https://hex.pm/packages/docs_getter) [![docs](https://img.shields.io/badge/docs-hexpm-blue.svg)](https://hexdocs.pm/docs_getter/)

Build docs for all dependencies

## Installation

The package can be installed

by adding `docs_getter` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:docs_getter, "~> 0.1-pre", only: :dev, runtime: false}

  ]

end

```

## Documentation

Documentation can be found at [https://hexdocs.pm/docs_getter](https://hexdocs.pm/docs_getter).

# Usage

Run

```

mix docs.build

```

and after a while you will get your docs build with page `Dependencies`, that will list all your deps.

![Docs with dependecies page](https://github.com/DanilaMihailov/docs_getter/blob/master/priv/screenshot.png?raw=true)

you can add docs folder to `.gitignore`

```

/doc_deps/

```