Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Build documentation from clojure code and specs #146

Open
ieugen opened this issue Jun 25, 2020 · 2 comments
Open

Build documentation from clojure code and specs #146

ieugen opened this issue Jun 25, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@ieugen
Copy link
Contributor

ieugen commented Jun 25, 2020

Desired Behavior

Code needs a good documentation.
A lot of documentation is written as function description or clojure specs.
There should be some support for building and publishing documentation from these sources.

Context

I would like to have a task that scans my clojre code and generates documentation from it.
It should look for function descriptions.
It should look for clojure spec definitions.
It should leverage existing tools.

Idea started from https://clojureverse.org/t/spec-aware-documentation-tools/6118/2 .
@ajoberstar
Copy link
Member

Is there a specific tool you have in mind? I've kind of gravitated towards cljdoc in the little time I've spent in Clojure recently. Not sure if it covers everything you mention, but it doesn't seem to require the build tool to do anything.

@ieugen
Copy link
Contributor Author

ieugen commented Jun 29, 2020

I don't have a preference.
There are some in the link I shared.
I'm still in Java land for now and I created the issue to remember and track it.
At least it should be documented (which I still plan to write at some point)

@ajoberstar ajoberstar added the enhancement New feature or request label Jul 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
No open projects
Clojurephant Board
Status: No status
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ajoberstar @ieugen