Document the use of relative outdir paths.

Fixes #37

docs/configuration.rst

@@ -18,8 +18,23 @@ configuration file option.
 ``site`` section
 ----------------
 
-The ``outdir`` option will determine the output directory. If a tilde character
-(``~``) is supplied, it will be expanded to the user's home directory.
+The ``outdir`` option will determine the output directory.
+
+The ``outdir`` permits relative paths.
+One useful pattern with relative paths
+is to set ``outdir = ..`` as the value.
+Source and output can exist
+in a single repository or directory.
+Putting the output at the root of a repository
+makes it easy to deploy the entire project as a website.
+When generating output
+or watching the source directory,
+handroll is aware of the source and
+allows the two directories to coexist
+without interference.
+
+If a tilde character (``~``) is supplied,
+it will be expanded to the user's home directory.
 
 The ``with_blog`` option set to ``true``, ``on``, ``yes``, or ``1`` will
 enable the blog extension.

docs/releases.rst

@@ -11,6 +11,7 @@ Version 2.1, In Development
 * Relax the frontmatter requirement and don't force the
   inclusion of the YAML directive (e.g., ``%YAML 1.1``).
 * Support Python 3.5.
+* An output directory can be a relative path.
 
 Version 2.0, Released July 25, 2015
 -----------------------------------

handroll/tests/test_configuration.py

@@ -88,3 +88,13 @@ def test_loads_domain_from_site(self):
         config = configuration.build_config(f.name, args)
 
         self.assertEqual('a_fake_domain', config.domain)
+
+    def test_converts_relative_paths(self):
+        conf_file = inspect.cleandoc(
+            """[site]
+            outdir = ..""")
+        with tempfile.NamedTemporaryFile(delete=False) as f:
+            f.write(conf_file.encode('utf-8'))
+        config = configuration.Configuration()
+        config.load_from_file(f.name)
+        self.assertEqual(os.path.abspath('..'), config.outdir)