Merge pull request #81 from Carreau/rtd

Build docs on readthedocs.

docs/autogen_config.py

@@ -13,6 +13,10 @@
 
 destination = os.path.join(os.path.dirname(__file__), 'source/config_options.rst')
 
-with open(destination, 'w') as f:
-    f.write(header)
-    f.write(JupyterQtConsoleApp().document_config_options())
+def main():
+    with open(destination, 'w') as f:
+        f.write(header)
+        f.write(JupyterQtConsoleApp().document_config_options())
+
+if __name__ == '__main__':
+    main()

docs/conda-env.yml

@@ -0,0 +1,12 @@
+name: qtconsole_docs
+channels:
+- asmeurer
+dependencies:
+- ipykernel
+- numpydoc # we seem to not use that, but removing break readthedocs conda (for now)
+- pexpect
+- pygments
+- pyqt
+- pip:
+    - recommonmark # we seem to not use that, but removing break readthedocs conda (for now)
+    - readthedocs-sphinx-ext # we seem to not use that, but removing break readthedocs conda (for now)

docs/source/conf.py

@@ -12,14 +12,20 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
-import os
-import shlex
 
 # Check the version information
 release_info = {}
 exec(compile(open('../../qtconsole/_version.py').read(), '../../qtconsole/_version.py', 'exec'), release_info)
 
+import os
+if os.environ.get('READTHEDOCS', None) == 'True':
+    print('On RTD, regen API')
+    #from ..autogen_config import main
+    ns = {'__file__':'../autogen_config.py'}
+    exec(compile(open('../autogen_config.py').read(), '../autogen_config.py', 'exec'), ns )
+    ns['main']()
+
+
 # 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.

readthedocs.yml

@@ -0,0 +1,5 @@
+conda:
+    file: docs/conda-env.yml
+python:
+    version: 2
+    setup_py_install: true