A Sphinx extension for linking to javadoc-generated API documentation.
sphinx-javalink is availabe from PyPI:
pip install sphinx-javalinkUse the javaref role to link to Java types, members, and packages:
Alpacas are best stored in a :javaref:`java.util.HashMap`, while clients
may find that goats perform best in a :javaref:`java.util.TreeMap`. In
either case, use :javaref:`biz.cloudgoats.api.Wizard#convert(Object)` to
produce legally binding contracts.
For more details, see the :javaref:`biz.cloudgoats.api` package.Reference targets use standard Javadoc @see and @link syntax.
Reference titles are generated based on the configuration options described
below. To use an explicit title, place the Java reference in angle brackets
following the title:
:javaref:`I like objects! <java.lang.Object>`By default, references must be fully qualified. For convenience, use the
javaimport directive to import commonly used types:
.. javaimport::
java.util.*
biz.cloudgoats.api.Wizard
Alpacas are best stored in a :javaref:`HashMap`, while clients may find
that goats perform best in a :javaref:`TreeMap`. In either case, use
:javaref:`Wizard#convert(Object)` to produce chocolate covered pebbles or
peanuts, depending on environmental factors.
For more details, see the :javaref:`biz.cloudgoats.api` package.Each import appears on its own line and may be either a type or a package name
followed by a *. As in Java, this imports all types in the package. All
types in the java.lang package are imported by default.
The javaimport directive must appear before the first javaref that uses
one of the imported types. A document can have multiple javaimport
directives; the imports are cumulative.
A simple example conf.py is included in the repository. For real-world
examples, see these projects:
Default: []
A list of jar files and directories in which to search for classes. Elements can take one of three forms:
/path/to/library.jar- an absolute or relative path to a jar file/path/to/classes/dir- an absolute or relative path a directory containing class files/path/to/jar/dir/*- an absolute or relative path a directory containing jar files. Only jar files that are direct children of the directory are loaded.
All relative paths are relative to the source directory.
To link to classes in the standard library, rt.jar (shipped with the JRE)
must be on the class path. Use javalink.find_rt_jar() to find the location
of this jar on the local system. This function respects the JAVA_HOME
environment variable and may optionally take the path to an alternative
directory as an argument.
Default: []
A list of Javadocs that can be the target of links. A valid package-list
file must exist in the directory specified by the root path or URL.
List elements may be either:
- A string
- A dictionary with the following keys:
root(string, required)base(string, optional)version(integer, optional)
Providing a string is equivalent to providing a dictionary with only the
root key.
root is a path or URL used to fine the package-list file. base is
the base component of generated links; if it is not specified, the value of
root is used. version is the version of the javadoc tool used to
generate the documentation; if it is not specified, the value of
javalink_default_version is used.
Specifying a base that differs from root is useful when the
package-list is available at a local path that is not available from the
built and published documentation. This also allows offline builds, by
downloading all remote package-list files ahead of time.
Default: 7
The version of the javadoc tool assumed if a version is not provided for a
docroot. The version determines the format of generated links, which was
changed in Java 8.
Default: True
A boolean that determines if parameter lists and parentheses are appended to generated method references. References with explicit titles are not modified.
Default: True
A boolean that determines if fully-qualified package names are prepended to generated references. References with explicit titles are not modified.
Default: True
A boolean that determines if containing type names are prepended to generated
references to nested types. Only applies if javalink_add_package_names is
False. References with explicit titles are not modified.
- When linking to methods, only the types of arguments may be specified. Specifying argument names will produce incorrect results.
- All references are created as
literalnodes.
- Python 2.7 (no support for Python 3)
- Sphinx
- javatools
Pull requests, bug reports, and feature requests are welcome.
MIT, see the LICENSE file.
0.11.1 (2016-01-13)
- Open resources lazily
- Fix incorrect environment cache invalidation
- Fix potential ordering issues with Sphinx events (thanks to @rlepinski)
0.11.0 (2015-12-13)
- Significantly improve performance (10x speedup in testing)
- Cache missing classes (thanks to @rlepinski)
- Open all resources at startup instead of reopening for every class search
- Fix reporting of invalid references for class paths with class files
0.10.2 (2015-12-02)
- Support linking to overloaded methods (thanks to @thasso)
0.10.1 (2015-09-02)
- Fix syntax error in
env-merge-infohook (thanks to @dadouf)
0.10.0 (2015-08-30)
- Support the
env-merge-infohook - Fix #5 - support Java 8 link formats; required a breaking change to the
javalink_docrootssyntax (thanks to @dadouf)
0.9.2 (2015-03-08)
- Fix #3 - resolve paths relative to the source directory
0.9.1 (2015-03-03)
- Fix #2 - correctly generate links to varargs methods
- Fix #1 -
find_rt_jar()now works correctly on OS X
0.9.0 (2015-01-25)
- Initial release
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent