Permalink
Browse files

docs: Get rid of the source/ directory

Flatten the directory structure.  It's simpler.

Signed-off-by: David Aguilar <davvid@gmail.com>
  • Loading branch information...
1 parent 3fa5f51 commit f940a58e67e824a1c2423a864f0a078f306376fb @davvid davvid committed Nov 24, 2012
View
@@ -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
File renamed without changes.
@@ -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
@@ -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
File renamed without changes.
File renamed without changes.

0 comments on commit f940a58

Please sign in to comment.