docs/source/_ext/javasphinx/README.md

   1
   2 # javasphinx
   3
   4 [![Documentation Status](https://readthedocs.org/projects/bronto-javasphinx/badge/?version=latest)](http://bronto-javasphinx.readthedocs.io/en/latest/?badge=latest)
   5
   6 **This project is no longer maintained and should be used for historical purposes only.**
   7
   8 javasphinx is an extension to the Sphinx documentation system which adds support for documenting Java projects. It includes a Java domain for writing documentation manually and a javasphinx-apidoc utility which will automatically generate API documentation from existing Javadoc markup.
   9
  10 javasphinx is available in the Python Package Index (PyPi) under the name _javasphinx_ and can be installed using tools such as `pip` or `easy_install`.
  11
  12 Documentation for javasphinx is available at http://bronto-javasphinx.readthedocs.io