From f6ddb711545efa7ce1fa189f3c33f08fa9567061 Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Sat, 9 Mar 2013 00:53:01 -0800 Subject: [PATCH] refer to replace.txt in the documentation template --- src/create-module.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/create-module.py b/src/create-module.py index fa329d50c..e04f839cc 100755 --- a/src/create-module.py +++ b/src/create-module.py @@ -213,18 +213,24 @@ static %(CAPITALIZED)sTestSuite %(MODULE)sTestSuite; DOC_RST_TEMPLATE = '''Example Module Documentation ---------------------------- +.. include:: replace.txt + .. heading hierarchy: ------------- Chapter ************* Section (#.#) ============= Subsection (#.#.#) ############# Paragraph (no number) -This is a suggested outline for adding new module documentation to ns-3. +This is a suggested outline for adding new module documentation to |ns3|. See ``src/click/doc/click.rst`` for an example. The introductory paragraph is for describing what this code is trying to model. +For consistency (italicized formatting), please use |ns3| to refer to +ns-3 in the documentation (and likewise, |ns2| for ns-2). These macros +are defined in the file ``replace.txt``. + Model Description *****************