change reST extension from .txt to .rst

GitHub automatically renders reST in files ending in .rst, but not .txt Addresses #416
usnistgov · Dec 17, 2015 · 9ab1012 · 9ab1012
1 parent 6e897df
commit 9ab1012
Show file tree

Hide file tree

Showing 52 changed files with 30 additions and 30 deletions.
diff --git a/DISCLAIMER.txt → DISCLAIMER.rst b/DISCLAIMER.txt → DISCLAIMER.rst
diff --git a/INSTALLATION.txt → INSTALLATION.rst b/INSTALLATION.txt → INSTALLATION.rst
diff --git a/LICENSE.txt → LICENSE.rst b/LICENSE.txt → LICENSE.rst
diff --git a/MANIFEST-WINDOWS.in b/MANIFEST-WINDOWS.in
@@ -1,10 +1,10 @@
-include *.txt
+include *.rst
 
-recursive-include examples *.py *.msh *.gz *.txt
+recursive-include examples *.py *.msh *.gz *.rst
 recursive-include fipy *.msh
 include FiPy-*.win32.exe
 
-recursive-include documentation/ *.txt
+recursive-include documentation/ *.rst
 recursive-exclude examples *.png *.pdf
 recursive-exclude fipy *.png *.pdf
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,7 +1,7 @@
-include *.txt
-# include MANIFEST MANIFEST.in *.txt
+include *.rst
+# include MANIFEST MANIFEST.in *.rst
 
-recursive-include documentation *.txt
+recursive-include documentation *.rst
 recursive-exclude examples *.png *.pdf
 recursive-exclude fipy *.png *.pdf
 

diff --git a/README.txt → README.rst b/README.txt → README.rst
diff --git a/documentation/ADMINISTRATA.txt → documentation/ADMINISTRATA.rst b/documentation/ADMINISTRATA.txt → documentation/ADMINISTRATA.rst
diff --git a/documentation/API.txt → documentation/API.rst b/documentation/API.txt → documentation/API.rst
diff --git a/documentation/BUILDBOT.txt → documentation/BUILDBOT.rst b/documentation/BUILDBOT.txt → documentation/BUILDBOT.rst
diff --git a/documentation/CODESPEED.txt → documentation/CODESPEED.rst b/documentation/CODESPEED.txt → documentation/CODESPEED.rst
diff --git a/documentation/CREDITS.txt → documentation/CREDITS.rst b/documentation/CREDITS.txt → documentation/CREDITS.rst
diff --git a/documentation/EFFICIENCY.txt → documentation/EFFICIENCY.rst b/documentation/EFFICIENCY.txt → documentation/EFFICIENCY.rst
diff --git a/documentation/FAQ.txt → documentation/FAQ.rst b/documentation/FAQ.txt → documentation/FAQ.rst
diff --git a/documentation/GIT.txt → documentation/GIT.rst b/documentation/GIT.txt → documentation/GIT.rst
diff --git a/documentation/GUIDELINES.txt → documentation/GUIDELINES.rst b/documentation/GUIDELINES.txt → documentation/GUIDELINES.rst
diff --git a/documentation/MAIL.txt → documentation/MAIL.rst b/documentation/MAIL.txt → documentation/MAIL.rst
diff --git a/documentation/PUBLICATIONS.txt → documentation/PUBLICATIONS.rst b/documentation/PUBLICATIONS.txt → documentation/PUBLICATIONS.rst
diff --git a/documentation/RESOURCES.txt → documentation/RESOURCES.rst b/documentation/RESOURCES.txt → documentation/RESOURCES.rst
diff --git a/documentation/SOLVERS.txt → documentation/SOLVERS.rst b/documentation/SOLVERS.txt → documentation/SOLVERS.rst
diff --git a/documentation/USAGE.txt → documentation/USAGE.rst b/documentation/USAGE.txt → documentation/USAGE.rst
diff --git a/documentation/VIEWERS.txt → documentation/VIEWERS.rst b/documentation/VIEWERS.txt → documentation/VIEWERS.rst
diff --git a/documentation/VKML.txt → documentation/VKML.rst b/documentation/VKML.txt → documentation/VKML.rst
diff --git a/documentation/conf.py b/documentation/conf.py
@@ -40,7 +40,7 @@
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.txt'
+source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8'
@@ -81,15 +81,15 @@
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
-exclude_patterns = ['fipy/generated/modules.txt',
-                    'fipy/generated/__init__.txt',
+exclude_patterns = ['fipy/generated/modules.rst',
+                    'fipy/generated/__init__.rst',
                     'build', 
                     'dist',
                     'FiPy.egg-info', 
                     'documentation/_build', 
-                    'documentation/tutorial/package/generated/modules.txt',
+                    'documentation/tutorial/package/generated/modules.rst',
                     'documentation/sphinxext',
-                    'documentation/sphinxext/bibtex/bibstuff/examples/*.txt',
+                    'documentation/sphinxext/bibtex/bibstuff/examples/*.rst',
                     '**/.svn',
                     '**/.git']
 
@@ -115,14 +115,14 @@
 
 autoclass_content = "both"
 
-autosummary_generate = ['examples/diffusion/index.txt',
-                        'examples/convection/index.txt',
-                        'examples/phase/index.txt',
-                        'examples/levelSet/index.txt',
-                        'examples/cahnHilliard/index.txt',
-                        'examples/flow/index.txt',
-                        'examples/reactiveWetting/index.txt',
-                        'examples/updating/index.txt']
+autosummary_generate = ['examples/diffusion/index.rst',
+                        'examples/convection/index.rst',
+                        'examples/phase/index.rst',
+                        'examples/levelSet/index.rst',
+                        'examples/cahnHilliard/index.rst',
+                        'examples/flow/index.rst',
+                        'examples/reactiveWetting/index.rst',
+                        'examples/updating/index.rst']
 
 autodoc_member_order = 'alphabetical'
 

diff --git a/documentation/contents.txt → documentation/contents.rst b/documentation/contents.txt → documentation/contents.rst
diff --git a/documentation/design.txt → documentation/design.rst b/documentation/design.txt → documentation/design.rst
diff --git a/documentation/glossary.txt → documentation/glossary.rst b/documentation/glossary.txt → documentation/glossary.rst
diff --git a/documentation/introduction.txt → documentation/introduction.rst b/documentation/introduction.txt → documentation/introduction.rst
diff --git a/documentation/manual.txt → documentation/manual.rst b/documentation/manual.txt → documentation/manual.rst
diff --git a/documentation/numerical/discret.txt → documentation/numerical/discret.rst b/documentation/numerical/discret.txt → documentation/numerical/discret.rst
diff --git a/documentation/numerical/equation.txt → documentation/numerical/equation.rst b/documentation/numerical/equation.txt → documentation/numerical/equation.rst
diff --git a/documentation/numerical/index.txt → documentation/numerical/index.rst b/documentation/numerical/index.txt → documentation/numerical/index.rst
diff --git a/documentation/numerical/scheme.txt → documentation/numerical/scheme.rst b/documentation/numerical/scheme.txt → documentation/numerical/scheme.rst
diff --git a/documentation/references-latex.txt → documentation/references-latex.rst b/documentation/references-latex.txt → documentation/references-latex.rst
diff --git a/documentation/references.txt → documentation/references.rst b/documentation/references.txt → documentation/references.rst
diff --git a/documentation/tutorial/index.txt → documentation/tutorial/index.rst b/documentation/tutorial/index.txt → documentation/tutorial/index.rst
diff --git a/examples/README.txt → examples/README.rst b/examples/README.txt → examples/README.rst
diff --git a/examples/cahnHilliard/generated/.gitignore b/examples/cahnHilliard/generated/.gitignore
@@ -1 +1 @@
-*.txt
+*.rst
diff --git a/examples/cahnHilliard/index.txt → examples/cahnHilliard/index.rst b/examples/cahnHilliard/index.txt → examples/cahnHilliard/index.rst
diff --git a/examples/convection/index.txt → examples/convection/index.rst b/examples/convection/index.txt → examples/convection/index.rst
diff --git a/examples/diffusion/generated/.gitignore b/examples/diffusion/generated/.gitignore
@@ -1 +1 @@
-*.txt
+*.rst
diff --git a/examples/diffusion/index.txt → examples/diffusion/index.rst b/examples/diffusion/index.txt → examples/diffusion/index.rst
diff --git a/examples/flow/generated/.gitignore b/examples/flow/generated/.gitignore
@@ -1 +1 @@
-*.txt
+*.rst
diff --git a/examples/flow/index.txt → examples/flow/index.rst b/examples/flow/index.txt → examples/flow/index.rst
diff --git a/examples/levelSet/electroChem/README.txt → examples/levelSet/electroChem/README.rst b/examples/levelSet/electroChem/README.txt → examples/levelSet/electroChem/README.rst
diff --git a/examples/levelSet/generated/.gitignore b/examples/levelSet/generated/.gitignore
@@ -1 +1 @@
-*.txt
+*.rst
diff --git a/examples/levelSet/index.txt → examples/levelSet/index.rst b/examples/levelSet/index.txt → examples/levelSet/index.rst
diff --git a/examples/phase/generated/.gitignore b/examples/phase/generated/.gitignore
@@ -1 +1 @@
-*.txt
+*.rst
diff --git a/examples/phase/index.txt → examples/phase/index.rst b/examples/phase/index.txt → examples/phase/index.rst
diff --git a/examples/reactiveWetting/index.txt → examples/reactiveWetting/index.rst b/examples/reactiveWetting/index.txt → examples/reactiveWetting/index.rst
diff --git a/examples/updating/index.txt → examples/updating/index.rst b/examples/updating/index.txt → examples/updating/index.rst
diff --git a/fipy/generated/.gitignore b/fipy/generated/.gitignore
@@ -1 +1 @@
-*.txt
+*.rst
diff --git a/setup.py b/setup.py
@@ -93,9 +93,9 @@ def run (self):
             sphinx_args = ['-a', '-E'] + sphinx_args
             apidoc_args = ['--force'] + apidoc_args
 
-        apidoc.main(['sphinx-apidoc', '--output-dir=fipy/generated', '--suffix=txt'] 
+        apidoc.main(['sphinx-apidoc', '--output-dir=fipy/generated', '--suffix=rst'] 
                     + apidoc_args + ['fipy'])
-        apidoc.main(['sphinx-apidoc', '--output-dir=documentation/tutorial/package/generated', '--suffix=txt'] 
+        apidoc.main(['sphinx-apidoc', '--output-dir=documentation/tutorial/package/generated', '--suffix=rst'] 
                     + apidoc_args + ['documentation/tutorial/package'])
 
         if self.html:
@@ -109,7 +109,7 @@ def run (self):
             from docutils.core import publish_file
 
             for xtra in ("LICENSE", "DISCLAIMER"):
-                publish_file(source_path="%s.txt" % xtra,
+                publish_file(source_path="%s.rst" % xtra,
                              destination_path=os.path.join(outdir, "%s.tex" % xtra),
                              reader_name='standalone',
                              parser_name='restructuredtext',
@@ -193,14 +193,14 @@ def run(self):
                 webbrowser.open("http://matforge.org/fipy/wiki/FiPyManual?action=edit", autoraise=False)
 
 try:            
-    f = open('README.txt', 'r')
+    f = open('README.rst', 'r')
     long_description = '\n' + f.read() + '\n'
     f.close()
 except IOError, e:
     long_description = ''
 
 try:
-    f = open('LICENSE.txt', 'r') 
+    f = open('LICENSE.rst', 'r') 
     license = '\n' + ''.join([' '*8 + l for l in f])
     f.close()
 except IOError, e: