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
20 Commits 14 Branches 43 Tags 5 MiB
Python 94.2%
Makefile 3.1%
Go 2.2%
JavaScript 0.5%
655aff0245
Go to file
Anthony Johnson 655aff0245 Cleaning up detail page formatting and order
2015-04-14 19:55:46 -07:00
autoapi Cleaning up detail page formatting and order 2015-04-14 19:55:46 -07:00
tests Sorting on list and detail pages, plus type and ref type fixes to classes 2015-04-14 18:05:15 -07:00
.gitignore Large refactor. Cleans up, adds tests, intermediate namespaces 2015-04-14 15:59:09 -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 Large refactor. Cleans up, adds tests, intermediate namespaces 2015-04-14 15:59:09 -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