Reorganization (flatification)

- can ``make html`` from doc directory and get html. - documentation tests run as part of normal tests. README.rst needs some love. Then on to making this work with RTD.
zopefoundation · Sep 8, 2016 · 49497c7 · 49497c7
1 parent f192110
commit 49497c7
Show file tree

Hide file tree

Showing 30 changed files with 26 additions and 12 deletions.
diff --git a/buildout.cfg b/buildout.cfg
@@ -3,6 +3,7 @@ develop = .
 parts =
     test
     scripts
+    sphinx
 
 [versions]
 # Avoid breakage in 4.4.5:
@@ -40,3 +41,15 @@ arguments = ('${buildout:directory}/coverage',
 recipe = zc.recipe.egg
 eggs = ${test:eggs}
 interpreter = py
+
+[sphinx]
+recipe = zc.recipe.egg
+eggs =
+    Sphinx
+    docutils
+    ZODB
+    j1m.sphinxautointerface
+    j1m.sphinxautozconfig
+scripts =
+    sphinx-build
+interpreter = stxpy
diff --git a/doc/Makefile b/doc/Makefile
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = bin/sphinx-build
+SPHINXBUILD   = ../bin/sphinx-build
 PAPER         =
 
 # Internal variables.

diff --git a/doc/documentation/articles/ZODB-overview.rst → doc/articles/ZODB-overview.rst b/doc/documentation/articles/ZODB-overview.rst → doc/articles/ZODB-overview.rst
diff --git a/doc/documentation/articles/ZODB1.rst → doc/articles/ZODB1.rst b/doc/documentation/articles/ZODB1.rst → doc/articles/ZODB1.rst
diff --git a/doc/documentation/articles/ZODB2.rst → doc/articles/ZODB2.rst b/doc/documentation/articles/ZODB2.rst → doc/articles/ZODB2.rst
diff --git a/...mentation/articles/images/zeo-diagram.png → doc/articles/images/zeo-diagram.png b/...mentation/articles/images/zeo-diagram.png → doc/articles/images/zeo-diagram.png
diff --git a/doc/documentation/articles/index.rst → doc/articles/index.rst b/doc/documentation/articles/index.rst → doc/articles/index.rst
diff --git a/doc/documentation/articles/multi-zodb-gc.rst → doc/articles/multi-zodb-gc.rst b/doc/documentation/articles/multi-zodb-gc.rst → doc/articles/multi-zodb-gc.rst
diff --git a/doc/documentation/articles/old-guide/README → doc/articles/old-guide/README b/doc/documentation/articles/old-guide/README → doc/articles/old-guide/README
diff --git a/doc/documentation/articles/old-guide/TODO → doc/articles/old-guide/TODO b/doc/documentation/articles/old-guide/TODO → doc/articles/old-guide/TODO
diff --git a/...cumentation/articles/old-guide/chatter.py → doc/articles/old-guide/chatter.py b/...cumentation/articles/old-guide/chatter.py → doc/articles/old-guide/chatter.py
diff --git a/.../articles/old-guide/convert_zodb_guide.py → doc/articles/old-guide/convert_zodb_guide.py b/.../articles/old-guide/convert_zodb_guide.py → doc/articles/old-guide/convert_zodb_guide.py
diff --git a/...documentation/articles/old-guide/gfdl.rst → doc/articles/old-guide/gfdl.rst b/...documentation/articles/old-guide/gfdl.rst → doc/articles/old-guide/gfdl.rst
diff --git a/...ocumentation/articles/old-guide/index.rst → doc/articles/old-guide/index.rst b/...ocumentation/articles/old-guide/index.rst → doc/articles/old-guide/index.rst
diff --git a/...ation/articles/old-guide/introduction.rst → doc/articles/old-guide/introduction.rst b/...ation/articles/old-guide/introduction.rst → doc/articles/old-guide/introduction.rst
diff --git a/...ocumentation/articles/old-guide/links.rst → doc/articles/old-guide/links.rst b/...ocumentation/articles/old-guide/links.rst → doc/articles/old-guide/links.rst
diff --git a/...umentation/articles/old-guide/modules.rst → doc/articles/old-guide/modules.rst b/...umentation/articles/old-guide/modules.rst → doc/articles/old-guide/modules.rst
diff --git a/...entation/articles/old-guide/prog-zodb.rst → doc/articles/old-guide/prog-zodb.rst b/...entation/articles/old-guide/prog-zodb.rst → doc/articles/old-guide/prog-zodb.rst
diff --git a/...ation/articles/old-guide/transactions.rst → doc/articles/old-guide/transactions.rst b/...ation/articles/old-guide/transactions.rst → doc/articles/old-guide/transactions.rst
diff --git a/doc/documentation/articles/old-guide/zeo.rst → doc/articles/old-guide/zeo.rst b/doc/documentation/articles/old-guide/zeo.rst → doc/articles/old-guide/zeo.rst
diff --git a/doc/documentation/guide/index.rst → doc/guide/index.rst b/doc/documentation/guide/index.rst → doc/guide/index.rst
diff --git a/doc/documentation/guide/install-and-run.rst → doc/guide/install-and-run.rst b/doc/documentation/guide/install-and-run.rst → doc/guide/install-and-run.rst
diff --git a/...tion/guide/writing-persistent-objects.rst → doc/guide/writing-persistent-objects.rst b/...tion/guide/writing-persistent-objects.rst → doc/guide/writing-persistent-objects.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -14,7 +14,7 @@ Because ZODB is an object database:
 
 - almost no seam between code and database.
 
-Check out the :doc:`documentation/tutorial`!
+Check out the :doc:`tutorial`!
 
 Transactions
 ============
@@ -196,10 +196,10 @@ Learning more
 .. toctree::
    :maxdepth: 1
 
-   documentation/tutorial
-   documentation/guide/index
-   documentation/reference/index
-   documentation/articles/index
+   tutorial
+   guide/index
+   reference/index
+   articles/index
 
 * `The ZODB Book (in progress) <http://zodb.readthedocs.org/en/latest/>`_ 
 

diff --git a/doc/documentation/reference/index.rst → doc/reference/index.rst b/doc/documentation/reference/index.rst → doc/reference/index.rst
diff --git a/doc/documentation/reference/storages.rst → doc/reference/storages.rst b/doc/documentation/reference/storages.rst → doc/reference/storages.rst
diff --git a/doc/documentation/reference/zodb.rst → doc/reference/zodb.rst b/doc/documentation/reference/zodb.rst → doc/reference/zodb.rst
diff --git a/doc/documentation/tutorial.rst → doc/tutorial.rst b/doc/documentation/tutorial.rst → doc/tutorial.rst
diff --git a/doc/zodbdocumentationtests/__init__.py b/doc/zodbdocumentationtests/__init__.py
diff --git a/doc/zodbdocumentationtests/tests.py → src/ZODB/tests/testdocumentation.py b/doc/zodbdocumentationtests/tests.py → src/ZODB/tests/testdocumentation.py
@@ -11,6 +11,7 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
+from os.path import join
 import os
 import doctest
 import unittest
@@ -19,10 +20,9 @@
 import manuel.testing
 import zope.testing.module
 
-from os.path import join
+import ZODB
 
 def setUp(test):
-    import ZODB
     test.globs.update(
         ZODB=ZODB,
         )
@@ -32,9 +32,11 @@ def tearDown(test):
     zope.testing.module.tearDown(test)
 
 def test_suite():
-    here = os.path.dirname(__file__)
-    guide = join(here, '..', 'documentation', 'guide')
-    reference = join(here, '..', 'documentation', 'reference')
+    base, src = os.path.split(os.path.dirname(os.path.dirname(ZODB.__file__)))
+    assert src == 'src'
+    base = join(base, 'doc')
+    guide = join(base, 'guide')
+    reference = join(base, 'reference')
 
     return unittest.TestSuite((
         manuel.testing.TestSuite(