diff --git a/.gitignore b/.gitignore index d82873a073..9261f0ecf6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +/docs/apidocs *~ *.*~ .achievements diff --git a/Makefile b/Makefile index 2fa29483b7..5f5fa9b702 100644 --- a/Makefile +++ b/Makefile @@ -407,7 +407,7 @@ apidocs: @echo ""Generating API doc for InaSAFE @echo "---------------------------------------------------------------" @echo "Generate RST files for apidoc" - @sphinx-apidoc -f -e -o docs safe realtime + @sphinx-apidoc -f -e -o docs/apidocs safe realtime @echo "rst files for apidocs has been created." @echo "Go to docs directory to run make command for building the apidocs." @echo "It can be html, text, latex, epub, json, or other formats." \ No newline at end of file diff --git a/docs/api-docs/Makefile b/docs/Makefile similarity index 100% rename from docs/api-docs/Makefile rename to docs/Makefile diff --git a/docs/api-docs/conf.py b/docs/conf.py similarity index 99% rename from docs/api-docs/conf.py rename to docs/conf.py index a54337c7c2..fc06f2d141 100644 --- a/docs/api-docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath('..')) # -- General configuration ------------------------------------------------ diff --git a/docs/api-docs/index.rst b/docs/index.rst similarity index 100% rename from docs/api-docs/index.rst rename to docs/index.rst diff --git a/docs/api-docs/make.bat b/docs/make.bat similarity index 100% rename from docs/api-docs/make.bat rename to docs/make.bat