From 30e473fd9cc65590129b49d8754de3e9410d182a Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Wed, 22 Apr 2015 15:50:46 -0700 Subject: [PATCH] Reverse include --- README.rst | 48 +----------------------------------------------- 1 file changed, 1 insertion(+), 47 deletions(-) diff --git a/README.rst b/README.rst index 2165237..eab5b3d 100644 --- a/README.rst +++ b/README.rst @@ -1,47 +1 @@ -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. - -Install -------- - -First you need to install autoapi. - -.. code:: bash - - pip install sphinx-autoapi - -Then add it to your Sphinx project's ``conf.py``: - -.. code:: python - - extensions = ['autoapi.extension'] - - autoapi_type = 'python' - autoapi_dir = 'path/to/my/project/files' - autoapi_output = 'path/to/output' - -See all available configuration options in :doc:`config`. - -Design ------- - -Read more about the deisgn in our :doc:`design`. - -Currently Implemented ---------------------- - -* Python -* .Net - -Future ------- -Our goal is to support the following soon: - -* Javascript -* PHP -* Python -* Go +.. include:: docs/index.rst \ No newline at end of file