Merge pull request #3802 from ivanov/doc-to-rst

This renames our documentation files to .rst so that it renders nicely on GitHub

The docs build just fine with these changes, it'd be good to get this in before any more changes are made to the docs

docs/source/config/index.rst

@@ -0,0 +1,16 b''
+.. _config_index:
+
+===============================
+Configuration and customization
+===============================
+
+.. toctree::
+   :maxdepth: 2
+
+   overview
+   extensions/index
+   ipython
+   integrating
+   editors
+   inputtransforms
+   old

docs/source/interactive/index.rst

@@ -0,0 +1,15 b''
+==================================
+Using IPython for interactive work
+==================================
+
+.. toctree::
+   :maxdepth: 2
+
+   tutorial
+   tips
+   reference
+   shell
+   qtconsole
+   htmlnotebook
+
+

docs/source/parallel/index.rst

@@ -0,0 +1,25 b''
+.. _parallel_index:
+
+====================================
+Using IPython for parallel computing
+====================================
+
+.. toctree::
+   :maxdepth: 2
+
+   parallel_intro
+   parallel_process
+   parallel_multiengine
+   magics
+   parallel_task
+   asyncresult
+   parallel_mpi
+   parallel_db
+   parallel_security
+   parallel_winhpc
+   parallel_demos
+   dag_dependencies
+   parallel_details
+   parallel_transition
+
+

docs/Makefile

@@ -110,11 +110,10 b' linkcheck:'
 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
-	      "or in build/linkcheck/output.txt."
+	      "or in build/linkcheck/output.rst."
 
 gitwash-update:
 	python ../tools/gitwash_dumper.py source/development ipython
-	cd source/development/gitwash && rename 's/.rst/.txt/' *.rst
 
 nightly: dist
 	rsync -avH --delete dist/ ipython:www/doc/nightly

docs/autogen_api.py

@@ -14,7 +14,7 b" if __name__ == '__main__':"
     pjoin = os.path.join
     package = 'IPython'
     outdir = pjoin('source','api','generated')
-    docwriter = ApiDocWriter(package,rst_extension='.txt')
+    docwriter = ApiDocWriter(package,rst_extension='.rst')
     # You have to escape the . here because . is a special char for regexps.
     # You must do make clean if you change this!
     docwriter.package_skip_patterns += [r'\.fixes$',
@@ -58,9 +58,9 b" if __name__ == '__main__':"
                                            r'\.testing\.mkdoctests']
     # Now, generate the outputs
     docwriter.write_api_docs(outdir)
-    # Write index with .rst extension - we can include it, but Sphinx won't try
+    # Write index with .txt extension - we can include it, but Sphinx won't try
     # to compile it
-    docwriter.write_index(outdir, 'gen.rst',
+    docwriter.write_index(outdir, 'gen.txt',
                           relative_to = pjoin('source','api')
                           )
     print ('%d files written' % len(docwriter.written_modules))

docs/make.cmd

@@ -36,7 +36,7 b' FOR %%L IN (html pickle htmlhelp latex changes linkcheck) DO ('
         )
         IF "%1" == "linkcheck" (
             ECHO Look for any errors in the above output
-            ECHO    or in build\linkcheck\output.txt.
+            ECHO    or in build\linkcheck\output.rst.
         )
         GOTO END
     )

docs/source/api/index.rst

@@ -9,4 +9,4 b''
    :Release: |version|
    :Date: |today|
 
-.. include:: generated/gen.rst
+.. include:: generated/gen.txt

docs/source/conf.py

@@ -67,7 +67,7 b' if ON_RTD:'
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.txt'
+source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'

docs/source/development/index.rst

@@ -20,7 +20,7 b' on the IPython GitHub wiki.'
    :maxdepth: 1
 
  
-   gitwash/index.txt
-   messaging.txt
-   parallel_messages.txt
-   parallel_connections.txt
+   gitwash/index
+   messaging
+   parallel_messages
+   parallel_connections

docs/source/development/messaging.rst

@@ -1058,4 +1058,4 b' Missing things include:'
 * Signal handling: specify what kind of information kernel should broadcast (or
   not) when it receives signals.
 
-.. include:: ../links.rst
+.. include:: ../links.txt

docs/source/index.rst

@@ -21,15 +21,15 b' Contents'
 .. toctree::
    :maxdepth: 1
 
-   overview.txt
-   whatsnew/index.txt
-   install/index.txt
-   interactive/index.txt
-   parallel/index.txt
-   config/index.txt
-   development/index.txt
-   api/index.txt
-   about/index.txt
+   overview
+   whatsnew/index
+   install/index
+   interactive/index
+   parallel/index
+   config/index
+   development/index
+   api/index
+   about/index
 
 .. htmlonly::
    * :ref:`genindex`

docs/source/install/index.rst

@@ -7,5 +7,5 b' Installation'
 .. toctree::
    :maxdepth: 2
 
-   install.txt
+   install
 

docs/source/parallel/winhpc_index.rst

@@ -9,6 +9,6 b' Contents'
 .. toctree::
    :maxdepth: 1
 
-   parallel_winhpc.txt
-   parallel_demos.txt
+   parallel_winhpc
+   parallel_demos