bluekeyes / sphinx-javalink Goto Github PK

Paths in javalink_classpath and javalink_docroots claim to be relative to the source directory. Instead, they are relative to the working directory of sphinx-build. Fix the docs or the code, but probably the code.

Now that Sphinx 1.3 is released, add support for the new env-merge-info hook so that parallel document reading works correctly.

Hey,

I've been using sphinx-javalink plugin for my project (http://dev.flitch.io). Good job, it's very neat and rather easy to setup ;)

I run into a problem that has to see with a difference of behaviour between what Javadoc expects, and what your tool generates. Example here: http://dev.flitch.io/sdkandroid.html#bind-to-flitchio

In that paragraph, the hyperlink over onCreate() is:
http://dev.flitch.io/javadoc/com/supenta/flitchio/sdk/FlitchioController.html#onCreate()

Yet when we follow the link, it doesn't go to the right anchor. Indeed, when we look for the anchor, it is actually:
http://dev.flitch.io/javadoc/com/supenta/flitchio/sdk/FlitchioController.html#onCreate--

The difference is with the last 2 characters, the brackets, that Javadoc has encoded as dashes. I couldn't see any configuration to influence this behaviour, in either Javadoc or sphinx-javalink. I use very standard settings in both.

What can I do?
Thank you very much.

Because Apple dropped support for Java after Java 6 and left things to Oracle for Java 7 and Java 8, the way Java works on OS X is... non-standard. The program linked to /usr/bin/java is a wrapper that finds the latest Oracle binaries or uses the value given in JAVA_HOME and as a result, the assumption that find_rt_jar makes about the location of rt.jar relative to java is incorrect. If you set JAVA_HOME to point to the Oracle install (using /usr/libexec/java_home), then everything works as expected.

If running on OS X and no other options are set, we should probably execute /usr/libexec/java_home to find JAVA_HOME instead of guessing it based on the location of java.

To link to a varargs method, you have to use array syntax, but anchor tags for these methods use the ... syntax.

Check with javadoc to see what it allows for links and then fix this to do the same thing. I suspect we need to support both options for references, but only use varargs syntax in generated URLs.