diff --git a/docs/Makefile b/docs/Makefile index 6ae59a5..c5d2df4 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -110,11 +110,10 @@ 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 diff --git a/docs/README.txt b/docs/README.rst similarity index 100% rename from docs/README.txt rename to docs/README.rst diff --git a/docs/autogen_api.py b/docs/autogen_api.py index 26aade7..74f841d 100755 --- a/docs/autogen_api.py +++ b/docs/autogen_api.py @@ -14,7 +14,7 @@ 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 @@ 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)) diff --git a/docs/make.cmd b/docs/make.cmd index d4e003d..00b1b74 100644 --- a/docs/make.cmd +++ b/docs/make.cmd @@ -36,7 +36,7 @@ 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 ) diff --git a/docs/source/about/credits.txt b/docs/source/about/credits.rst similarity index 100% rename from docs/source/about/credits.txt rename to docs/source/about/credits.rst diff --git a/docs/source/about/history.txt b/docs/source/about/history.rst similarity index 100% rename from docs/source/about/history.txt rename to docs/source/about/history.rst diff --git a/docs/source/about/index.txt b/docs/source/about/index.rst similarity index 100% rename from docs/source/about/index.txt rename to docs/source/about/index.rst diff --git a/docs/source/about/license_and_copyright.txt b/docs/source/about/license_and_copyright.rst similarity index 100% rename from docs/source/about/license_and_copyright.txt rename to docs/source/about/license_and_copyright.rst diff --git a/docs/source/api/index.txt b/docs/source/api/index.rst similarity index 87% rename from docs/source/api/index.txt rename to docs/source/api/index.rst index 7b0bea3..d5c55f4 100644 --- a/docs/source/api/index.txt +++ b/docs/source/api/index.rst @@ -9,4 +9,4 @@ :Release: |version| :Date: |today| -.. include:: generated/gen.rst +.. include:: generated/gen.txt diff --git a/docs/source/attic/parallel_task_old.txt b/docs/source/attic/parallel_task_old.rst similarity index 100% rename from docs/source/attic/parallel_task_old.txt rename to docs/source/attic/parallel_task_old.rst diff --git a/docs/source/conf.py b/docs/source/conf.py index 85a78c7..7060c25 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -67,7 +67,7 @@ if ON_RTD: templates_path = ['_templates'] # The suffix of source filenames. -source_suffix = '.txt' +source_suffix = '.rst' # The master toctree document. master_doc = 'index' diff --git a/docs/source/config/editors.txt b/docs/source/config/editors.rst similarity index 100% rename from docs/source/config/editors.txt rename to docs/source/config/editors.rst diff --git a/docs/source/config/extensions/autoreload.txt b/docs/source/config/extensions/autoreload.rst similarity index 100% rename from docs/source/config/extensions/autoreload.txt rename to docs/source/config/extensions/autoreload.rst diff --git a/docs/source/config/extensions/cythonmagic.txt b/docs/source/config/extensions/cythonmagic.rst similarity index 100% rename from docs/source/config/extensions/cythonmagic.txt rename to docs/source/config/extensions/cythonmagic.rst diff --git a/docs/source/config/extensions/index.txt b/docs/source/config/extensions/index.rst similarity index 100% rename from docs/source/config/extensions/index.txt rename to docs/source/config/extensions/index.rst diff --git a/docs/source/config/extensions/octavemagic.txt b/docs/source/config/extensions/octavemagic.rst similarity index 100% rename from docs/source/config/extensions/octavemagic.txt rename to docs/source/config/extensions/octavemagic.rst diff --git a/docs/source/config/extensions/rmagic.txt b/docs/source/config/extensions/rmagic.rst similarity index 100% rename from docs/source/config/extensions/rmagic.txt rename to docs/source/config/extensions/rmagic.rst diff --git a/docs/source/config/extensions/storemagic.txt b/docs/source/config/extensions/storemagic.rst similarity index 100% rename from docs/source/config/extensions/storemagic.txt rename to docs/source/config/extensions/storemagic.rst diff --git a/docs/source/config/extensions/sympyprinting.txt b/docs/source/config/extensions/sympyprinting.rst similarity index 100% rename from docs/source/config/extensions/sympyprinting.txt rename to docs/source/config/extensions/sympyprinting.rst diff --git a/docs/source/config/index.rst b/docs/source/config/index.rst new file mode 100644 index 0000000..38e206c --- /dev/null +++ b/docs/source/config/index.rst @@ -0,0 +1,16 @@ +.. _config_index: + +=============================== +Configuration and customization +=============================== + +.. toctree:: + :maxdepth: 2 + + overview + extensions/index + ipython + integrating + editors + inputtransforms + old diff --git a/docs/source/config/index.txt b/docs/source/config/index.txt deleted file mode 100644 index 0e0a230..0000000 --- a/docs/source/config/index.txt +++ /dev/null @@ -1,16 +0,0 @@ -.. _config_index: - -=============================== -Configuration and customization -=============================== - -.. toctree:: - :maxdepth: 2 - - overview.txt - extensions/index.txt - ipython.txt - integrating.txt - editors.txt - inputtransforms.txt - old.txt diff --git a/docs/source/config/inputtransforms.txt b/docs/source/config/inputtransforms.rst similarity index 100% rename from docs/source/config/inputtransforms.txt rename to docs/source/config/inputtransforms.rst diff --git a/docs/source/config/integrating.txt b/docs/source/config/integrating.rst similarity index 100% rename from docs/source/config/integrating.txt rename to docs/source/config/integrating.rst diff --git a/docs/source/config/ipython.txt b/docs/source/config/ipython.rst similarity index 100% rename from docs/source/config/ipython.txt rename to docs/source/config/ipython.rst diff --git a/docs/source/config/old.txt b/docs/source/config/old.rst similarity index 100% rename from docs/source/config/old.txt rename to docs/source/config/old.rst diff --git a/docs/source/config/overview.txt b/docs/source/config/overview.rst similarity index 100% rename from docs/source/config/overview.txt rename to docs/source/config/overview.rst diff --git a/docs/source/development/gitwash/configure_git.txt b/docs/source/development/gitwash/configure_git.rst similarity index 100% rename from docs/source/development/gitwash/configure_git.txt rename to docs/source/development/gitwash/configure_git.rst diff --git a/docs/source/development/gitwash/development_workflow.txt b/docs/source/development/gitwash/development_workflow.rst similarity index 100% rename from docs/source/development/gitwash/development_workflow.txt rename to docs/source/development/gitwash/development_workflow.rst diff --git a/docs/source/development/gitwash/dot2_dot3.txt b/docs/source/development/gitwash/dot2_dot3.rst similarity index 100% rename from docs/source/development/gitwash/dot2_dot3.txt rename to docs/source/development/gitwash/dot2_dot3.rst diff --git a/docs/source/development/gitwash/following_latest.txt b/docs/source/development/gitwash/following_latest.rst similarity index 100% rename from docs/source/development/gitwash/following_latest.txt rename to docs/source/development/gitwash/following_latest.rst diff --git a/docs/source/development/gitwash/forking_hell.txt b/docs/source/development/gitwash/forking_hell.rst similarity index 100% rename from docs/source/development/gitwash/forking_hell.txt rename to docs/source/development/gitwash/forking_hell.rst diff --git a/docs/source/development/gitwash/git_development.txt b/docs/source/development/gitwash/git_development.rst similarity index 100% rename from docs/source/development/gitwash/git_development.txt rename to docs/source/development/gitwash/git_development.rst diff --git a/docs/source/development/gitwash/git_install.txt b/docs/source/development/gitwash/git_install.rst similarity index 100% rename from docs/source/development/gitwash/git_install.txt rename to docs/source/development/gitwash/git_install.rst diff --git a/docs/source/development/gitwash/git_resources.txt b/docs/source/development/gitwash/git_resources.rst similarity index 100% rename from docs/source/development/gitwash/git_resources.txt rename to docs/source/development/gitwash/git_resources.rst diff --git a/docs/source/development/gitwash/index.txt b/docs/source/development/gitwash/index.rst similarity index 100% rename from docs/source/development/gitwash/index.txt rename to docs/source/development/gitwash/index.rst diff --git a/docs/source/development/gitwash/patching.txt b/docs/source/development/gitwash/patching.rst similarity index 100% rename from docs/source/development/gitwash/patching.txt rename to docs/source/development/gitwash/patching.rst diff --git a/docs/source/development/gitwash/set_up_fork.txt b/docs/source/development/gitwash/set_up_fork.rst similarity index 100% rename from docs/source/development/gitwash/set_up_fork.txt rename to docs/source/development/gitwash/set_up_fork.rst diff --git a/docs/source/development/index.txt b/docs/source/development/index.rst similarity index 78% rename from docs/source/development/index.txt rename to docs/source/development/index.rst index d019ed1..87edb9a 100644 --- a/docs/source/development/index.txt +++ b/docs/source/development/index.rst @@ -20,7 +20,7 @@ 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 diff --git a/docs/source/development/inputhook_app.txt b/docs/source/development/inputhook_app.rst similarity index 100% rename from docs/source/development/inputhook_app.txt rename to docs/source/development/inputhook_app.rst diff --git a/docs/source/development/messaging.txt b/docs/source/development/messaging.rst similarity index 99% rename from docs/source/development/messaging.txt rename to docs/source/development/messaging.rst index 8600ea4..f146e34 100644 --- a/docs/source/development/messaging.txt +++ b/docs/source/development/messaging.rst @@ -1058,4 +1058,4 @@ 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 diff --git a/docs/source/development/parallel_connections.txt b/docs/source/development/parallel_connections.rst similarity index 100% rename from docs/source/development/parallel_connections.txt rename to docs/source/development/parallel_connections.rst diff --git a/docs/source/development/parallel_messages.txt b/docs/source/development/parallel_messages.rst similarity index 100% rename from docs/source/development/parallel_messages.txt rename to docs/source/development/parallel_messages.rst diff --git a/docs/source/index.txt b/docs/source/index.rst similarity index 67% rename from docs/source/index.txt rename to docs/source/index.rst index c97d512..2ddf644 100644 --- a/docs/source/index.txt +++ b/docs/source/index.rst @@ -21,15 +21,15 @@ 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` diff --git a/docs/source/install/index.txt b/docs/source/install/index.rst similarity index 85% rename from docs/source/install/index.txt rename to docs/source/install/index.rst index 9879894..0fd8fd9 100644 --- a/docs/source/install/index.txt +++ b/docs/source/install/index.rst @@ -7,5 +7,5 @@ Installation .. toctree:: :maxdepth: 2 - install.txt + install diff --git a/docs/source/install/install.txt b/docs/source/install/install.rst similarity index 100% rename from docs/source/install/install.txt rename to docs/source/install/install.rst diff --git a/docs/source/interactive/htmlnotebook.txt b/docs/source/interactive/htmlnotebook.rst similarity index 100% rename from docs/source/interactive/htmlnotebook.txt rename to docs/source/interactive/htmlnotebook.rst diff --git a/docs/source/interactive/index.rst b/docs/source/interactive/index.rst new file mode 100644 index 0000000..1ce17bc --- /dev/null +++ b/docs/source/interactive/index.rst @@ -0,0 +1,15 @@ +================================== +Using IPython for interactive work +================================== + +.. toctree:: + :maxdepth: 2 + + tutorial + tips + reference + shell + qtconsole + htmlnotebook + + diff --git a/docs/source/interactive/index.txt b/docs/source/interactive/index.txt deleted file mode 100644 index d342c7b..0000000 --- a/docs/source/interactive/index.txt +++ /dev/null @@ -1,15 +0,0 @@ -================================== -Using IPython for interactive work -================================== - -.. toctree:: - :maxdepth: 2 - - tutorial.txt - tips.txt - reference.txt - shell.txt - qtconsole.txt - htmlnotebook.txt - - diff --git a/docs/source/interactive/qtconsole.txt b/docs/source/interactive/qtconsole.rst similarity index 100% rename from docs/source/interactive/qtconsole.txt rename to docs/source/interactive/qtconsole.rst diff --git a/docs/source/interactive/reference.txt b/docs/source/interactive/reference.rst similarity index 100% rename from docs/source/interactive/reference.txt rename to docs/source/interactive/reference.rst diff --git a/docs/source/interactive/shell.txt b/docs/source/interactive/shell.rst similarity index 100% rename from docs/source/interactive/shell.txt rename to docs/source/interactive/shell.rst diff --git a/docs/source/interactive/tips.txt b/docs/source/interactive/tips.rst similarity index 100% rename from docs/source/interactive/tips.txt rename to docs/source/interactive/tips.rst diff --git a/docs/source/interactive/tutorial.txt b/docs/source/interactive/tutorial.rst similarity index 100% rename from docs/source/interactive/tutorial.txt rename to docs/source/interactive/tutorial.rst diff --git a/docs/source/links.rst b/docs/source/links.txt similarity index 100% rename from docs/source/links.rst rename to docs/source/links.txt diff --git a/docs/source/overview.txt b/docs/source/overview.rst similarity index 100% rename from docs/source/overview.txt rename to docs/source/overview.rst diff --git a/docs/source/parallel/asyncresult.txt b/docs/source/parallel/asyncresult.rst similarity index 100% rename from docs/source/parallel/asyncresult.txt rename to docs/source/parallel/asyncresult.rst diff --git a/docs/source/parallel/dag_dependencies.txt b/docs/source/parallel/dag_dependencies.rst similarity index 100% rename from docs/source/parallel/dag_dependencies.txt rename to docs/source/parallel/dag_dependencies.rst diff --git a/docs/source/parallel/index.rst b/docs/source/parallel/index.rst new file mode 100644 index 0000000..7da57a0 --- /dev/null +++ b/docs/source/parallel/index.rst @@ -0,0 +1,25 @@ +.. _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 + + diff --git a/docs/source/parallel/index.txt b/docs/source/parallel/index.txt deleted file mode 100644 index be8b957..0000000 --- a/docs/source/parallel/index.txt +++ /dev/null @@ -1,25 +0,0 @@ -.. _parallel_index: - -==================================== -Using IPython for parallel computing -==================================== - -.. toctree:: - :maxdepth: 2 - - parallel_intro.txt - parallel_process.txt - parallel_multiengine.txt - magics.txt - parallel_task.txt - asyncresult.txt - parallel_mpi.txt - parallel_db.txt - parallel_security.txt - parallel_winhpc.txt - parallel_demos.txt - dag_dependencies.txt - parallel_details.txt - parallel_transition.txt - - diff --git a/docs/source/parallel/magics.txt b/docs/source/parallel/magics.rst similarity index 100% rename from docs/source/parallel/magics.txt rename to docs/source/parallel/magics.rst diff --git a/docs/source/parallel/parallel_db.txt b/docs/source/parallel/parallel_db.rst similarity index 100% rename from docs/source/parallel/parallel_db.txt rename to docs/source/parallel/parallel_db.rst diff --git a/docs/source/parallel/parallel_demos.txt b/docs/source/parallel/parallel_demos.rst similarity index 100% rename from docs/source/parallel/parallel_demos.txt rename to docs/source/parallel/parallel_demos.rst diff --git a/docs/source/parallel/parallel_details.txt b/docs/source/parallel/parallel_details.rst similarity index 100% rename from docs/source/parallel/parallel_details.txt rename to docs/source/parallel/parallel_details.rst diff --git a/docs/source/parallel/parallel_intro.txt b/docs/source/parallel/parallel_intro.rst similarity index 100% rename from docs/source/parallel/parallel_intro.txt rename to docs/source/parallel/parallel_intro.rst diff --git a/docs/source/parallel/parallel_mpi.txt b/docs/source/parallel/parallel_mpi.rst similarity index 100% rename from docs/source/parallel/parallel_mpi.txt rename to docs/source/parallel/parallel_mpi.rst diff --git a/docs/source/parallel/parallel_multiengine.txt b/docs/source/parallel/parallel_multiengine.rst similarity index 100% rename from docs/source/parallel/parallel_multiengine.txt rename to docs/source/parallel/parallel_multiengine.rst diff --git a/docs/source/parallel/parallel_process.txt b/docs/source/parallel/parallel_process.rst similarity index 100% rename from docs/source/parallel/parallel_process.txt rename to docs/source/parallel/parallel_process.rst diff --git a/docs/source/parallel/parallel_security.txt b/docs/source/parallel/parallel_security.rst similarity index 100% rename from docs/source/parallel/parallel_security.txt rename to docs/source/parallel/parallel_security.rst diff --git a/docs/source/parallel/parallel_task.txt b/docs/source/parallel/parallel_task.rst similarity index 100% rename from docs/source/parallel/parallel_task.txt rename to docs/source/parallel/parallel_task.rst diff --git a/docs/source/parallel/parallel_transition.txt b/docs/source/parallel/parallel_transition.rst similarity index 100% rename from docs/source/parallel/parallel_transition.txt rename to docs/source/parallel/parallel_transition.rst diff --git a/docs/source/parallel/parallel_winhpc.txt b/docs/source/parallel/parallel_winhpc.rst similarity index 100% rename from docs/source/parallel/parallel_winhpc.txt rename to docs/source/parallel/parallel_winhpc.rst diff --git a/docs/source/parallel/winhpc_index.txt b/docs/source/parallel/winhpc_index.rst similarity index 77% rename from docs/source/parallel/winhpc_index.txt rename to docs/source/parallel/winhpc_index.rst index d52da22..dad2e86 100644 --- a/docs/source/parallel/winhpc_index.txt +++ b/docs/source/parallel/winhpc_index.rst @@ -9,6 +9,6 @@ Contents .. toctree:: :maxdepth: 1 - parallel_winhpc.txt - parallel_demos.txt + parallel_winhpc + parallel_demos diff --git a/docs/source/whatsnew/development.txt b/docs/source/whatsnew/development.rst similarity index 100% rename from docs/source/whatsnew/development.txt rename to docs/source/whatsnew/development.rst diff --git a/docs/source/whatsnew/github-stats-0.11.txt b/docs/source/whatsnew/github-stats-0.11.rst similarity index 100% rename from docs/source/whatsnew/github-stats-0.11.txt rename to docs/source/whatsnew/github-stats-0.11.rst diff --git a/docs/source/whatsnew/github-stats-0.12.txt b/docs/source/whatsnew/github-stats-0.12.rst similarity index 100% rename from docs/source/whatsnew/github-stats-0.12.txt rename to docs/source/whatsnew/github-stats-0.12.rst diff --git a/docs/source/whatsnew/github-stats-0.13.txt b/docs/source/whatsnew/github-stats-0.13.rst similarity index 100% rename from docs/source/whatsnew/github-stats-0.13.txt rename to docs/source/whatsnew/github-stats-0.13.rst diff --git a/docs/source/whatsnew/github-stats-1.0.txt b/docs/source/whatsnew/github-stats-1.0.rst similarity index 100% rename from docs/source/whatsnew/github-stats-1.0.txt rename to docs/source/whatsnew/github-stats-1.0.rst diff --git a/docs/source/whatsnew/index.txt b/docs/source/whatsnew/index.rst similarity index 100% rename from docs/source/whatsnew/index.txt rename to docs/source/whatsnew/index.rst diff --git a/docs/source/whatsnew/version0.10.txt b/docs/source/whatsnew/version0.10.rst similarity index 100% rename from docs/source/whatsnew/version0.10.txt rename to docs/source/whatsnew/version0.10.rst diff --git a/docs/source/whatsnew/version0.11.txt b/docs/source/whatsnew/version0.11.rst similarity index 100% rename from docs/source/whatsnew/version0.11.txt rename to docs/source/whatsnew/version0.11.rst diff --git a/docs/source/whatsnew/version0.12.txt b/docs/source/whatsnew/version0.12.rst similarity index 100% rename from docs/source/whatsnew/version0.12.txt rename to docs/source/whatsnew/version0.12.rst diff --git a/docs/source/whatsnew/version0.13.txt b/docs/source/whatsnew/version0.13.rst similarity index 100% rename from docs/source/whatsnew/version0.13.txt rename to docs/source/whatsnew/version0.13.rst diff --git a/docs/source/whatsnew/version0.8.txt b/docs/source/whatsnew/version0.8.rst similarity index 100% rename from docs/source/whatsnew/version0.8.txt rename to docs/source/whatsnew/version0.8.rst diff --git a/docs/source/whatsnew/version0.9.txt b/docs/source/whatsnew/version0.9.rst similarity index 100% rename from docs/source/whatsnew/version0.9.txt rename to docs/source/whatsnew/version0.9.rst diff --git a/docs/source/whatsnew/version1.0.txt b/docs/source/whatsnew/version1.0.rst similarity index 100% rename from docs/source/whatsnew/version1.0.txt rename to docs/source/whatsnew/version1.0.rst