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.

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

Add option to emit a comprehensive index of the namespace metadata #9

Merged
merged 1 commit into from
Feb 24, 2012

Conversation

tobias
Copy link
Contributor

@tobias tobias commented Feb 23, 2012

This makes it easier to generate a single autodoc/ tree in a multiproject maven build, since the existing index.clj doesn't contain enough data to feed back to autodoc.build-html/make-all-pages.

Example usage: we use this in Immutant (http://immutant.org/) to build docs for each module, then discard all but the raw indexes, which are fed to:
https://github.com/immutant/immutant/blob/master/docs/src/main/clojure/immutant/docs/autodoc.clj

If there is a better way to solve the multiproject doc problem, I'm certainly open to that.

This makes it easier to generate a single autodoc/ tree in a multiproject build.
@tomfaulhaber
Copy link
Owner

Tobias,

This is a good addition. I'd certainly be interested in having this documented for others to use as well and if there's a way to include support for the second stage of generating the multi-project docs directly into autodoc (or a supporting project as I do with autodoc-index), that might be a great idea.

tomfaulhaber added a commit that referenced this pull request Feb 24, 2012
Add option to emit a comprehensive index of the namespace metadata
@tomfaulhaber tomfaulhaber merged commit 5eb039a into tomfaulhaber:master Feb 24, 2012
@tobias
Copy link
Contributor Author

tobias commented Feb 27, 2012

@tomfaulhaber - that's a good idea, I'll take a look at implementing the second stage in the next couple of weeks, and also document this behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants