search

trustin / sphinx-gradle-plugin

Sphinx site generation plugin for Gradle
https://trustin.github.io/sphinx-gradle-plugin/
Apache License 2.0
18 stars 7 forks source link

Using javasphinx-apidoc #9

Closed xtianus closed 6 years ago

xtianus commented 6 years ago

I don't understand if javasphinx-apidoc is supported and how to use it. I'd expect it to be invoked by gradle on the java source folders, but I don't see any output.

Sorry to ask questions in an "issue".

trustin commented 6 years ago

Hello @xtianus,

I did not try to use javasphinx-apidoc but it seems like it is a command-line tool you need to install by yourself. We could improve the plugin so it invokes the command before launching Sphinx, but it's not implemented currently.

Just in case you didn't check the official documentation of javasphinx: http://bronto-javasphinx.readthedocs.io/en/latest/

trustin commented 6 years ago

By the way, is it ever better than Javadoc? What's the benefit of using javasphinx-apidoc?

xtianus commented 6 years ago

I'm very new to sphinx. The only advantage I've seen so far is that with javasphinx-apidoc you can reference an api page by just using the class/method name, instead of using the full link to the javadoc. But now that I think of it, probably you can do the same by means of the javadoc_url_map.

trustin commented 6 years ago

Let me close this issue for now. Please feel free to open a new issue if you find issues with javasphinx.