docs: Get rid of the source/ directory

Flatten the directory structure. It's simpler. Signed-off-by: David Aguilar <davvid@gmail.com>
mockfs · Nov 24, 2012 · f940a58 · f940a58
1 parent 3fa5f51
commit f940a58
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -6,12 +6,12 @@ SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = build
-SOURCEDIR     = source
+SOURCEDIR     = .
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
 
 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
 

diff --git a/docs/source/api.rst → docs/api.rst b/docs/source/api.rst → docs/api.rst
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
@@ -16,8 +16,8 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
-sys.path.insert(1, os.path.abspath(os.path.join('..', '..',
+sys.path.insert(0, os.path.abspath(os.path.join('..')))
+sys.path.insert(1, os.path.abspath(os.path.join('..',
                                                 'thirdparty',
                                                 'sphinx-to-github')))
 import mockfs

diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
@@ -22,11 +22,11 @@ Example Unit Test
 
     class ExampleTestCase(unittest.TestCase):
         def setUp(self):
-            self.mfs = mockfs.setup()
+            self.mfs = mockfs.replace_builtins()
             self.mfs.add_entries({'/usr/bin/mockfs-magic': 'magic'})
 
         def tearDown(self):
-            mockfs.teardown()
+            mockfs.restore_builtins()
 
         def test_using_os_path(self):
             self.assertEqual(os.listdir('/usr/bin'), ['mockfs-magic'])
@@ -59,9 +59,9 @@ Currently supported functions:
 * :func:`os.walk`
 * :func:`shutil.rmtree`
 
-.. autofunction:: mockfs.setup
+.. autofunction:: mockfs.replace_builtins
 
-.. autofunction:: mockfs.teardown
+.. autofunction:: mockfs.restore_builtins
 
 
 Developer Documentation

diff --git a/docs/source/static/.gitignore → docs/static/.gitignore b/docs/source/static/.gitignore → docs/static/.gitignore
diff --git a/docs/source/static/searchtools.js → docs/static/searchtools.js b/docs/source/static/searchtools.js → docs/static/searchtools.js