Skip to content

Latest commit

 

History

History
13 lines (10 loc) · 987 Bytes

README.md

File metadata and controls

13 lines (10 loc) · 987 Bytes

An Indexer for Autodoc Data

When a user or organization has a number of projects that are documented using the autodoc system (https://github.com/tomfaulhaber/autodoc), this project can be used to create a master overview and index.

This is currently being used to document the Clojure core and contrib libraries and you can see the results at http://clojure.github.io.

I have not yet completely generalized this program and don't have any immediate plans to. On the other hand, it ought to be pretty easy to adapt it to your project. Just keep in mind that the Clojure logo and such are copyrighted by Rich Hickey and you'll need to get his permission to use them for uses other than Clojure itself.

License

Autodoc-index is licensed under the Eclipse Public License 1.0 (like Clojure itself) which can be found in the file epl-v10.html at the root of this distribution. This means it can go anywhere Clojure can go.