Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-17 21:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
5 Commits 14 Branches 43 Tags 5 MiB
Python 94.2%
Makefile 3.1%
Go 2.2%
JavaScript 0.5%
0d88911a53
Go to file
Eric Holscher 0d88911a53 Use proper namespace fanciness
2015-04-07 23:08:53 -07:00
autoapi Use proper namespace fanciness 2015-04-07 23:08:53 -07:00
tests Initial commit 2015-03-27 12:50:56 -07:00
.gitignore Initial commit 2015-03-27 12:50:56 -07:00
MANIFEST.in Initial commit 2015-03-27 12:50:56 -07:00
README.rst Initial commit 2015-03-27 12:50:56 -07:00
setup.cfg Initial commit 2015-03-27 12:50:56 -07:00
setup.py Initial commit 2015-03-27 12:50:56 -07:00

README.rst 

Sphinx Auto API
===============

A tool that generates a full API ref (Javadoc style) for your project.
It requires no RST and is fully automated,
while being integrated into Sphinx.

The first implementation is for Microsoft .Net.
Other implementations are encouraged for your language.

Design
------

Read more about the deisgn in our Design doc.

Future
------
Our goal is to support the following soon:

* Javascript
* PHP
* Python
* Go