Normalize docs.

- Move changelog to root project directory.  Leave a stub behind for Sphinx.

- Move 'doc' -> 'docs' and fix up.

- Use newer Sphinx locations for support files,  build targets.

.gitignore

+*.egg-info
+*.py?
 /.installed.cfg
 /.mr.developer.cfg
 /bin
 /build
 /develop
 /develop-eggs
-/doc/.build
+/docs/_build
+/include
+/lib
 /dist
 /eggs
 /parts
-/include/Acquisition
-/include/ExtensionClass
-/include/persistent
-*.egg-info
-*.py?

MANIFEST.in

 include *.txt
 include *.rst
 
-recursive-include doc *
+recursive-include docs *
 recursive-include src *
 
 global-exclude *.dll

README.rst

@@ -8,8 +8,8 @@ Zope2 is an open-source web application server.
 This document provides some general information about Zope2 and provides
 links to other documents.
 
-Installation information can be found in ``doc/INSTALL.rst``.  Other
-documentation is also in the "doc" directory and in the zope.org
+Installation information can be found in ``docs/INSTALL.rst``.  Other
+documentation is also in the "docs" directory and in the zope.org
 documentation section at http://docs.zope.org/ .
 
 General Zope information is available at http://www.zope.org/
@@ -17,10 +17,11 @@ General Zope information is available at http://www.zope.org/
 Installation
 ============
 
-Follow the instructions in ``doc/INSTALL.rst`` to install Zope.
+Follow the instructions in ``docs/INSTALL.rst`` to install Zope.
 
 If you do not have a source checkout with docs, you can find the latest
-install docs online at https://github.com/zopefoundation/Zope/blob/master/doc/INSTALL.rst
+install docs online at
+https://github.com/zopefoundation/Zope/blob/master/docs/INSTALL.rst
 
 Note that you *cannot* simply do ``easy_install zope2`` or
 ``pip install zope2``, because you need specific versions of all

docs/changes.rst

+.. include:: ../CHANGES.rst

doc/conf.py → docs/conf.py

@@ -29,7 +29,7 @@ import sys, os
 extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['.templates']
+templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -68,7 +68,7 @@ release = '4.0'
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
-exclude_trees = ['.build']
+exclude_trees = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -115,7 +115,7 @@ html_style = 'default.css'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['.static']
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

doc/index.rst → docs/index.rst

@@ -15,4 +15,4 @@ Contents:
    SIGNALS.rst
    DEBUGGING.rst
    maintenance.rst
-   CHANGES.rst
+   changes.rst

doc/operation.rst → docs/operation.rst

@@ -153,7 +153,7 @@ Troubleshooting
   you built Python from source all the configuration information
   should already be available.
 
-- See the :doc:`CHANGES` for important notes on this version of Zope.
+- See the :doc:`changes` for important notes on this version of Zope.
 
 
 

setup.py

@@ -21,6 +21,13 @@ additional_install_requires = []
 if sys.platform[:3].lower() == "win":
     additional_install_requires += ['nt_svcutils']
 
+here = os.path.abspath(os.path.dirname(__file__))
+def _read_file(filename):
+    with open(os.path.join(here, filename)) as f:
+        return f.read()
+
+README = _read_file('README.rst')
+CHANGES = _read_file('CHANGES.rst')
 
 setup(name='Zope2',
     version='4.0a1.dev',
@@ -29,8 +36,7 @@ setup(name='Zope2',
     description='Zope2 application server / web framework',
     author='Zope Foundation and Contributors',
     author_email='zope-dev@zope.org',
-    long_description=file("README.rst").read() + "\n" +
-                     file(os.path.join("doc", "CHANGES.rst")).read(),
+    long_description="\n\n".join([README, CHANGES]),
     classifiers=[
         'Development Status :: 6 - Mature',
         "Environment :: Web Environment",