Get the documantation build process running

Adjust the package layout and script in a way, that they
work within the readthedocs build process.

Author: elmar-hinz

.gitignore

@@ -3,7 +3,7 @@ __pycache__
 *.pyc
 /dist/
 /build/
-/docs/
+/documentation/
 _build/
 latest.txt
 next.txt

MANIFEST.in

@@ -5,3 +5,4 @@ include challenges/version.txt
 include HelloWorld/sample.txt
 include HelloWorld/result.txt
 recursive-include docs *
+recursive-include documentation *

README.rst

@@ -1,10 +1,15 @@
+
 ==================
 README: Challenges
 ==================
 
 Library to assist programming, testing and execution of solutions for coding
 challenges like those on stepik.org
 
+Find the full documentation at Readthedocs_.
+
+.. _Readthedocs: http://challenges.readthedocs.io
+
 A Minimal Hello World Class <Add>
 =================================
 

bin/release

@@ -8,20 +8,16 @@ def main():
     # pathes
     here = os.path.abspath(os.path.dirname(__file__))
     root = os.path.abspath(os.path.join(here, '..'))
-    sphinx = os.path.join(root, 'sphinx/')
-    docs = os.path.join(root, 'docs/')
+    sphinx = os.path.join(root, 'docs/')
+    docs = os.path.join(root, 'documentation/')
     dist = os.path.join(root, 'dist/')
-    html_source = os.path.join(root, 'sphinx/_build/html/')
-    html_target = os.path.join(root, 'docs/html/')
-    epub_source = os.path.join(root, 'sphinx/_build/epub/')
-    epub_target = os.path.join(root, 'docs/epub/')
-    rst_challenges = os.path.join(sphinx, 'challenges.rst')
-    rst_modules = os.path.join(sphinx, 'modules.rst')
-    rst_hello = os.path.join(sphinx, 'HelloWorld.rst')
+    html_source = os.path.join(sphinx, '_build/html/')
+    html_target = os.path.join(docs, 'html/')
+    epub_source = os.path.join(sphinx, '_build/epub/')
+    epub_target = os.path.join(docs, 'epub/')
 
     # commands
-    genapi = 'sphinx-apidoc --doc-project="API" --force -o sphinx . setup.py ' \
-             'release.py '
+    genapi = 'sphinx-apidoc --doc-project="API" --force -o docs . setup.py'
     genhtml = 'make html'
     genepub = 'make epub'
     gendist = './setup.py sdist'
@@ -57,11 +53,6 @@ def main():
     with cd(root):
         os.system(gendist)
 
-    # cleanup autogenerated rst files
-    os.remove(rst_challenges)
-    os.remove(rst_hello)
-    os.remove(rst_modules)
-
     # Upload test
     print('Trying upload on TESTPYPI')
     with cd(root):

docs/HelloWorld.rst

@@ -0,0 +1,30 @@
+HelloWorld package
+==================
+
+Submodules
+----------
+
+HelloWorld.HelloWorld module
+----------------------------
+
+.. automodule:: HelloWorld.HelloWorld
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+HelloWorld.HelloWorldTestCase module
+------------------------------------
+
+.. automodule:: HelloWorld.HelloWorldTestCase
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: HelloWorld
+    :members:
+    :undoc-members:
+    :show-inheritance:

sphinx/Makefile docs/Makefilesphinx/Makefile renamed to docs/Makefile

@@ -0,0 +1,54 @@
+challenges package
+==================
+
+Submodules
+----------
+
+challenges.challenge module
+---------------------------
+
+.. automodule:: challenges.challenge
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+challenges.conf module
+----------------------
+
+.. automodule:: challenges.conf
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+challenges.main module
+----------------------
+
+.. automodule:: challenges.main
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+challenges.runner module
+------------------------
+
+.. automodule:: challenges.runner
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+challenges.scaffold module
+--------------------------
+
+.. automodule:: challenges.scaffold
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: challenges
+    :members:
+    :undoc-members:
+    :show-inheritance: