Rename files so extension matches content.

zopefoundation · Nov 10, 2017 · 8b9003b · 8b9003b
1 parent da0dc05
commit 8b9003b
Show file tree

Hide file tree

Showing 56 changed files with 101 additions and 97 deletions.
diff --git a/CHANGES.txt → CHANGES.rst b/CHANGES.txt → CHANGES.rst
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,11 +1,12 @@
 global-include *.mo
 prune .tox
 include *.txt
+include *.rst
 include bootstrap.py
 include buildout.cfg
 include dev.cfg
 include tox.ini
 include .travis.yml
 include .coveragerc
-recursive-include src/z3c/form *.zcml *.pt *.js *.txt *.png *.dot *.ps *.po *.pot *.css
+recursive-include src/z3c/form *.zcml *.pt *.js *.rst *.png *.dot *.ps *.po *.pot *.css
 recursive-include benchmark *.py
diff --git a/README.txt → README.rst b/README.txt → README.rst
diff --git a/setup.py b/setup.py
@@ -43,22 +43,22 @@ def alltests():
 
 chapters = '\n'.join(
     [read('src', 'z3c', 'form', name)
-    for name in ('README.txt',
-                 'form.txt',
-                 'group.txt',
-                 'subform.txt',
-                 'field.txt',
-                 'button.txt',
-                 'zcml.txt',
-                 'validator.txt',
-                 'widget.txt',
-                 'contentprovider.txt',
-                 'action.txt',
-                 'value.txt',
-                 'datamanager.txt',
-                 'converter.txt',
-                 'term.txt',
-                 'util.txt',
+    for name in ('README.rst',
+                 'form.rst',
+                 'group.rst',
+                 'subform.rst',
+                 'field.rst',
+                 'button.rst',
+                 'zcml.rst',
+                 'validator.rst',
+                 'widget.rst',
+                 'contentprovider.rst',
+                 'action.rst',
+                 'value.rst',
+                 'datamanager.rst',
+                 'converter.rst',
+                 'term.rst',
+                 'util.rst',
                  )])
 
 
@@ -69,11 +69,11 @@ def alltests():
     author_email="zope-dev@zope.org",
     description="An advanced form and widget framework for Zope 3",
     long_description=(
-        read('README.txt')
+        read('README.rst')
         + '\n\n' +
         '.. contents:: \n\n' + chapters
         + '\n\n'
-        + read('CHANGES.txt')),
+        + read('CHANGES.rst')),
     license="ZPL 2.1",
     keywords="zope3 form widget",
     classifiers=[
@@ -114,7 +114,10 @@ def alltests():
             'zope.testing',
         ],
         adding=['zope.app.container >= 3.7'],
-        docs=['z3c.recipe.sphinxdoc'],
+        docs=[
+            'Sphinx',
+            'repoze.sphinx.autointerface',
+        ],
     ),
     install_requires=[
         'setuptools',

diff --git a/src/z3c/form/README.txt → src/z3c/form/README.rst b/src/z3c/form/README.txt → src/z3c/form/README.rst
@@ -7,97 +7,97 @@ is to provide a simple API but with the ability to easily customize any data or
 steps. This document, provides the content of this package's documentation
 files. The documents are ordered in the way they should be read:
 
-- ``form.txt`` [must read]
+- ``form.rst`` [must read]
 
   Describes the setup and usage of forms in the most common usages. Some
   details are provided to the structure of form components.
 
-- ``group.txt`` [must read]
+- ``group.rst`` [must read]
 
   This document describes how widget groups are implemented within this
   package and how they can be used.
 
-- ``subform.txt`` [must read]
+- ``subform.rst`` [must read]
 
   Introduces the complexities surrounding sub-forms and details two classes of
   sub-forms, including code examples.
 
-- ``field.txt`` [must read]
+- ``field.rst`` [must read]
 
   Provides a comprehensive explanation of the field manager API and how it is
   to be used.
 
-- ``button.txt`` [must read]
+- ``button.rst`` [must read]
 
   Provides a comprehensive explanation of the button manager API. It also
   outlines how to create buttons within schemas and how buttons are converted
   to actions.
 
-- ``zcml.txt`` [must read]
+- ``zcml.rst`` [must read]
 
   Explains the ZCML directives defines by this package, which are designed to
   make it easier to register new templates without writing Python code.
 
-- ``validator.txt`` [advanced users]
+- ``validator.rst`` [advanced users]
 
   Validators are used to validate converted form data. This document provides
   a comprehensive overview of the API and how to use it effectively.
 
-- ``widget.txt`` [advanced users]
+- ``widget.rst`` [advanced users]
 
   Explains in detail the design goals surrounding widgets and widget managers
   and how they were realized with the implemented API.
 
-- ``contentprovider.txt`` [advanced users]
+- ``contentprovider.rst`` [advanced users]
 
   Explains how to mix content providers in forms to render more html around
   widgets.
 
-- ``action.txt`` [advanced users]
+- ``action.rst`` [advanced users]
 
   Explains in detail the design goals surrounding action managers and
   actions. The execution of actions using action handlers is also covered. The
   document demonstrates how actions can be created without the use of buttons.
 
-- ``value.txt`` [informative]
+- ``value.rst`` [informative]
 
   The concept of attribute value adapters is introduced and fully
   explained. Some motivation for this new and powerful pattern is given as
   well.
 
-- ``datamanager.txt`` [informative]
+- ``datamanager.rst`` [informative]
 
   Data managers are resposnsible for accessing and writing the data. While
   attribute access is the most common case, data managers can also manage
   other data structures, such as dictionaries.
 
-- ``converter.txt`` [informative]
+- ``converter.rst`` [informative]
 
   Data converters convert data between internal and widget values and vice
   versa.
 
-- ``term.txt`` [informative]
+- ``term.rst`` [informative]
 
   Terms are wrappers around sources and vocabularies to provide a common
   interface for choices in this package.
 
-- ``util.txt`` [informative]
+- ``util.rst`` [informative]
 
   The ``util`` module provides several helper functions and classes. The
   components not tested otherwise are explained in this file.
 
-- ``adding.txt`` [informative]
+- ``adding.rst`` [informative]
 
   This module provides a base class for add forms that work with the
   ``IAdding`` interface.
 
-- ``testing.txt`` [informative]
+- ``testing.rst`` [informative]
 
   The ``testing`` module provides helper functions that make it easier to tet
   form-based code in unit tests. It also provides components that simplify
   testing in testbrowser and Selenium.
 
-- ``object-caveat.txt`` [informative]
+- ``object-caveat.rst`` [informative]
 
   Explains the current problems of ObjectWidget.
 
@@ -108,11 +108,11 @@ Browser Documentation
 There are several documentation files in the ``browser/`` sub-package. They
 mainly document the basic widgets provided by the package.
 
-- ``README.txt`` [advanced users]
+- ``README.rst`` [advanced users]
 
   This file contains a checklist, ensuring that all fields have a widget.
 
-- ``<fieldname>.txt``
+- ``<fieldname>.rst``
 
   Each field name documentation file comprehensively explains the widget and
   how it is ensured to work properly.
diff --git a/src/z3c/form/action.txt → src/z3c/form/action.rst b/src/z3c/form/action.txt → src/z3c/form/action.rst
diff --git a/src/z3c/form/adding.txt → src/z3c/form/adding.rst b/src/z3c/form/adding.txt → src/z3c/form/adding.rst
diff --git a/src/z3c/form/apidoc.zcml b/src/z3c/form/apidoc.zcml
@@ -11,72 +11,72 @@
     <apidoc:bookchapter
         id="z3c-form"
         title="z3c.form - Widgets and Forms"
-        doc_path="README.txt"
+        doc_path="README.rst"
         />
     <apidoc:bookchapter
         id="z3c-form-form"
         title="Forms"
-        doc_path="form.txt"
+        doc_path="form.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-subform"
         title="Sub-Forms"
-        doc_path="subform.txt"
+        doc_path="subform.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-field"
         title="Fields"
-        doc_path="field.txt"
+        doc_path="field.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-button"
         title="Buttons"
-        doc_path="button.txt"
+        doc_path="button.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-validator"
         title="Validators"
-        doc_path="validator.txt"
+        doc_path="validator.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-zcml"
         title="ZCML Directives"
-        doc_path="zcml.txt"
+        doc_path="zcml.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-widget"
         title="Widgets"
-        doc_path="widget.txt"
+        doc_path="widget.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-action"
         title="Actions"
-        doc_path="action.txt"
+        doc_path="action.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-value"
         title="Attribute Values"
-        doc_path="value.txt"
+        doc_path="value.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-datamanager"
         title="Data Managers"
-        doc_path="datamanager.txt"
+        doc_path="datamanager.rst"
         parent="z3c-form"
         />
     <apidoc:bookchapter
         id="z3c-form-converter"
         title="Data Converters"
-        doc_path="converter.txt"
+        doc_path="converter.rst"
         parent="z3c-form"
         />
   </configure>

diff --git a/src/z3c/form/browser/README.txt → src/z3c/form/browser/README.rst b/src/z3c/form/browser/README.txt → src/z3c/form/browser/README.rst
diff --git a/src/z3c/form/browser/button.txt → src/z3c/form/browser/button.rst b/src/z3c/form/browser/button.txt → src/z3c/form/browser/button.rst
diff --git a/src/z3c/form/browser/checkbox.txt → src/z3c/form/browser/checkbox.rst b/src/z3c/form/browser/checkbox.txt → src/z3c/form/browser/checkbox.rst
diff --git a/src/z3c/form/browser/file-testing.txt → src/z3c/form/browser/file-testing.rst b/src/z3c/form/browser/file-testing.txt → src/z3c/form/browser/file-testing.rst
diff --git a/src/z3c/form/browser/file.txt → src/z3c/form/browser/file.rst b/src/z3c/form/browser/file.txt → src/z3c/form/browser/file.rst
diff --git a/src/z3c/form/browser/image.txt → src/z3c/form/browser/image.rst b/src/z3c/form/browser/image.txt → src/z3c/form/browser/image.rst
diff --git a/src/z3c/form/browser/index.txt → src/z3c/form/browser/index.rst b/src/z3c/form/browser/index.txt → src/z3c/form/browser/index.rst
diff --git a/src/z3c/form/browser/multi.txt → src/z3c/form/browser/multi.rst b/src/z3c/form/browser/multi.txt → src/z3c/form/browser/multi.rst
diff --git a/...c/form/browser/multi_dict_integration.txt → ...c/form/browser/multi_dict_integration.rst b/...c/form/browser/multi_dict_integration.txt → ...c/form/browser/multi_dict_integration.rst
diff --git a/...c/form/browser/multi_list_integration.txt → ...c/form/browser/multi_list_integration.rst b/...c/form/browser/multi_list_integration.txt → ...c/form/browser/multi_list_integration.rst
diff --git a/src/z3c/form/browser/object.txt → src/z3c/form/browser/object.rst b/src/z3c/form/browser/object.txt → src/z3c/form/browser/object.rst
diff --git a/...browser/object_multi_dict_integration.txt → ...browser/object_multi_dict_integration.rst b/...browser/object_multi_dict_integration.txt → ...browser/object_multi_dict_integration.rst
diff --git a/...form/browser/object_multi_integration.txt → ...form/browser/object_multi_integration.rst b/...form/browser/object_multi_integration.txt → ...form/browser/object_multi_integration.rst
diff --git a/...browser/object_multi_list_integration.txt → ...browser/object_multi_list_integration.rst b/...browser/object_multi_list_integration.txt → ...browser/object_multi_list_integration.rst
diff --git a/...orm/browser/object_single_integration.txt → ...orm/browser/object_single_integration.rst b/...orm/browser/object_single_integration.txt → ...orm/browser/object_single_integration.rst
diff --git a/src/z3c/form/browser/objectmulti.txt → src/z3c/form/browser/objectmulti.rst b/src/z3c/form/browser/objectmulti.txt → src/z3c/form/browser/objectmulti.rst
diff --git a/src/z3c/form/browser/orderedselect.txt → src/z3c/form/browser/orderedselect.rst b/src/z3c/form/browser/orderedselect.txt → src/z3c/form/browser/orderedselect.rst
diff --git a/src/z3c/form/browser/password.txt → src/z3c/form/browser/password.rst b/src/z3c/form/browser/password.txt → src/z3c/form/browser/password.rst
diff --git a/src/z3c/form/browser/radio.txt → src/z3c/form/browser/radio.rst b/src/z3c/form/browser/radio.txt → src/z3c/form/browser/radio.rst
diff --git a/...z3c/form/browser/select-missing-terms.txt → ...z3c/form/browser/select-missing-terms.rst b/...z3c/form/browser/select-missing-terms.txt → ...z3c/form/browser/select-missing-terms.rst
diff --git a/src/z3c/form/browser/select-source.txt → src/z3c/form/browser/select-source.rst b/src/z3c/form/browser/select-source.txt → src/z3c/form/browser/select-source.rst
diff --git a/src/z3c/form/browser/select.txt → src/z3c/form/browser/select.rst b/src/z3c/form/browser/select.txt → src/z3c/form/browser/select.rst
diff --git a/src/z3c/form/browser/submit.txt → src/z3c/form/browser/submit.rst b/src/z3c/form/browser/submit.txt → src/z3c/form/browser/submit.rst