https://github.com/codamic/boot-codeina
A tool for generating API documentation from Clojure for both Clojure and ClojureScript.
https://github.com/codamic/boot-codeina
boot-codeina clojure
Last synced: 3 months ago
JSON representation
A tool for generating API documentation from Clojure for both Clojure and ClojureScript.
- Host: GitHub
- URL: https://github.com/codamic/boot-codeina
- Owner: Codamic
- License: other
- Created: 2016-11-06T09:28:35.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-06T10:56:11.000Z (about 9 years ago)
- Last Synced: 2025-03-01T11:32:46.863Z (11 months ago)
- Topics: boot-codeina, clojure
- Language: CSS
- Size: 24.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# boot-codeina
```clojure
[codamic/boot-codeina "0.2.0-SNAPSHOT"]
```
Tasks for generate beautiful api reference documentation for the [boot Clojure build tool][1]
## Usage
Add `boot-codeina` to your `build.boot` dependencies and `require` the namespace:
```clj
(set-env! :dependencies '[[codamic/boot-codeina "0.2.0-SNAPSHOT" :scope "test"]])
(require '[codamic.boot-codeina :refer :all])
(task-options!
apidoc {:version "0.1.0"
:title "MyPackage name"
:sources #{"src"}
:description "MyPackage description"})
```
And now, execute the `apidoc` task:
```bash
$ boot apidoc
Generated HTML docs in /home/user/yourproject/doc/api
```
You can get the detailed information passing `-h` parameter to the `apidoc` task:
```bash
$ boot apidoc -h
Generate beautiful api documentation.
Options:
-h, --help Print this help info.
-t, --title TITLE Set the project title to TITLE.
-s, --sources SOURCES Conj SOURCES onto sources to read.
-d, --description DESC Set the project description to DESC.
-v, --version VERSION Set the project version to VERSION.
-i, --include INCLUDE Conj INCLUDE onto include concrete namespaces.
-x, --exclude EXCLUDE Conj EXCLUDE onto exclude concrete namespaces.
-f, --format FORMAT Set docstring format to FORMAT.
-o, --target OUTDIR Set the output directory to OUTDIR.
-n, --root ROOTDIR Set the project root directory to ROOTDIR.
-u, --src-uri SRCURI Set source code uri to SRCURI.
-w, --writer WRITER Set documentation writer to WRITER.
-r, --reader READER Set source reader to READER.
```
[1]: https://github.com/boot-clj/boot
## Examples ##
- https://cpda.github.io/buddy-auth/latest/api/
- https://cpda.github.io/catacumba/latest/api/