Added '--with-child-links' option.

CHANGES.md

@@ -13,6 +13,7 @@ Changelog
 - Changed '--no-rlink-check' to '--no-child-check'
 - Added Item.find_child_items() and Item.find_child_documents()
 - Added aliases to Item: parent_links, child_links/items/documents
+- Added '--with-child-links' to 'doorstop publish' to publish child links
 
 0.5 (2014/04/25)
 ----------------

Makefile

@@ -103,9 +103,9 @@ apidocs/$(PACKAGE)/index.html: $(SOURCES)
 html: env docs/gen/*.html
 docs/gen/*.html: $(shell find . -name '*.yml')
 	- $(MAKE) doorstop
-	$(BIN)/doorstop publish all docs/gen --text --with-child-links
-	$(BIN)/doorstop publish all docs/gen --markdown --with-child-links
-	$(BIN)/doorstop publish all docs/gen --html --with-child-links
+	$(BIN)/doorstop publish all docs/gen --text
+	$(BIN)/doorstop publish all docs/gen --markdown
+	$(BIN)/doorstop publish all docs/gen --html
 
 .PHONY: read
 read: readme apidocs html

doorstop/cli/main.py

@@ -107,6 +107,8 @@ def main(args=None):  # pylint: disable=R0915
                      help="output HTML (default for 'all')")
     sub.add_argument('-w', '--width', type=int,
                      help="limit line width on text output")
+    sub.add_argument('-C', '--with-child-links', action='store_true',
+                     help="include child links in published documents")
 
     # Parse arguments
     args = parser.parse_args(args=args)
@@ -336,6 +338,11 @@ def _run_publish(args, cwd, err):
     @param err: function to call for CLI errors
 
     """
+    # Configure publishing settings
+    if args.with_child_links is not None:
+        settings.PUBLISH_CHILD_LINKS = args.with_child_links
+
+    # Build the tree to publish
     publish_tree = args.prefix == 'all'
     try:
         tree = build(cwd, root=args.project)

doorstop/cli/test/test_all.py

@@ -258,10 +258,22 @@ class TestPublish(unittest.TestCase):  # pylint: disable=R0904
     def setUp(self):
         self.cwd = os.getcwd()
         self.temp = tempfile.mkdtemp()
+        self.backup = (settings.PUBLISH_CHILD_LINKS,)
 
     def tearDown(self):
         os.chdir(self.cwd)
         shutil.rmtree(self.temp)
+        (settings.PUBLISH_CHILD_LINKS,) = self.backup
+
+    def test_publish(self):
+        """Verify 'doorstop publish' can create output."""
+        self.assertIs(None, main(['publish', 'tut']))
+        self.assertFalse(settings.PUBLISH_CHILD_LINKS)
+
+    def test_publish_with_child_links(self):
+        """Verify 'doorstop publish' can create output with child links."""
+        self.assertIs(None, main(['publish', 'tut', '--with-child-links']))
+        self.assertTrue(settings.PUBLISH_CHILD_LINKS)
 
     def test_publish_error(self):
         """Verify 'doorstop publish' returns an error in an empty folder."""