sphinx-contrib / doxylink /

Filename Size Date modified Message
..
doc
sphinxcontrib
test
747 B
55 B
857 B
83 B
1.1 KB
364 B

sphinxcontrib-doxylink

A Sphinx extension to link to external Doxygen API documentation.

Installation

This extension can be installed from the Python Package Index:

pip install sphinxcontrib-doxylink

Alternatively, you can clone the sphinx-contrib repository from BitBucket, and install the extension directly from the repository:

hg clone http://bitbucket.org/birkenfeld/sphinx-contrib
cd sphinx-contrib/doxylink
python setup.py install

Usage

Please refer to the documentation file for information on using this extension.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.