https://github.com/jamesnvc/lein-depdocs

Leiningen plugin to generate documentation about how functions are used in the codebase
https://github.com/jamesnvc/lein-depdocs

clojure documentation-generator leiningen

Last synced: 3 days ago
JSON representation

Leiningen plugin to generate documentation about how functions are used in the codebase

• Host: GitHub
• URL: https://github.com/jamesnvc/lein-depdocs
• Owner: jamesnvc
• License: epl-1.0
• Created: 2017-04-02T01:26:36.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-09-06T13:48:40.000Z (almost 9 years ago)
• Last Synced: 2026-06-18T20:07:13.844Z (29 days ago)
• Topics: clojure, documentation-generator, leiningen
• Language: Clojure
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# depdocs

A Leiningen plugin to generate dependency documentation

[![Clojars Project](https://img.shields.io/clojars/v/lein-depdocs.svg)](https://clojars.org/lein-depdocs)

## Usage

Put `[lein-depdocs "1.0.0"]` into the `:plugins` vector of your `:user`

profile.

The plugin outputs markdown, so you can use it as follows (using [cmark-gfm](https://github.com/github/cmark/)).

    $ lein depdocs | cmark-gfm > docs/usage_docs.html

Example output:



rookie.common.util

==========

## Uses of  `rookie.common.util/ensure-coll`

Defined on line 11

### Uses in  `rookie.server.db`

At line 124 column 15

```clojure

(map ensure-coll props)

```

## Uses of  `rookie.common.util/nice-count`

Defined on line 3

## Uses of  `rookie.common.util/if?`

Defined on line 7

### Uses in  `rookie.common.util`

At line 11 column 18

```clojure

(if? coll? identity list)

```



## License

Copyright © 2017 James Cash

Distributed under the Eclipse Public License either version 1.0 or (at

your option) any later version.