From 59af9d2beff44f2d4341055cad47ea2f018be953 Mon Sep 17 00:00:00 2001
From: "hax0kartik (GCI 2019)" <>
Date: Tue, 25 Feb 2020 13:17:18 -0800
Subject: [PATCH] doc: Build command to generate docset docs

---
 doc/.gitignore                                |   7 +-
 doc/ns3_html_theme/static/ns-3-bars-16x16.png | Bin 0 -> 620 bytes
 doc/ns3_html_theme/static/ns-3-bars-32x32.png | Bin 0 -> 1212 bytes
 wscript                                       |  67 ++++++++++++++++++
 4 files changed, 72 insertions(+), 2 deletions(-)
 create mode 100644 doc/ns3_html_theme/static/ns-3-bars-16x16.png
 create mode 100644 doc/ns3_html_theme/static/ns-3-bars-32x32.png

diff --git a/doc/.gitignore b/doc/.gitignore
index 2b4b76d19..ae11ebb97 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -1,8 +1,11 @@
-html/
-html-warn/
+/docset/
+/html/
+/html-warn/
+/ns-3.docset
 latex/
 ns3-object.txt
 introspected-doxygen.h
+doxygen.docset.conf
 doxygen.log
 doxygen.warnings.log
 */build/
diff --git a/doc/ns3_html_theme/static/ns-3-bars-16x16.png b/doc/ns3_html_theme/static/ns-3-bars-16x16.png
new file mode 100644
index 0000000000000000000000000000000000000000..bd36c1cbb5dde584b9bf69c815a2a8e120996ccf
GIT binary patch
literal 620
zcmV-y0+aoTP)<h;3K|Lk000e1NJLTq000mG000mO1^@s6AM^iV00004XF*Lt006O%
z3;baP0000WV@Og>004R>004l5008;`004mK004C`008P>0026e000+ooVrmw0005^
zNkl<ZI1$BCzfV*_5T2Rc$9pdX4HAPE8ViH5G0}oVA`KmhSXgLmDE$wNvAci6#>!aS
zMH7BQ_ycUXaBxDStwJnBxE$x+z1?wUxic4~AU16BcK3Zd^L_KpF2K1B2K;Yr?k4MM
z&&r~~l?u@AE-)g5*Bg+?+BsVps))cnv87r%<{8(7^bPgE(^gg0Pm@=7E?iov=Z`hc
z2b>%p!5bXl#Xkg+K;<$R4U`hK+^F1XyO*Qa;Qf3pd(IpVoMVt!_jeCa{b{m}rF!;C
z6doe|nsJVXinf3rE;GUpl0XoCDwQBs5la<haVwi#*~uR$ft)`Zxq=hENXLOg10_=Y
zbmCcevO*9QwbZ%#;3#{)T(lV%YWXc@K4><gk3!i_G=-yY*bmi#+gW1X3R)>#cozr~
zUjQZKhiHHT^}0lASt=0gB%HA^VwWt^?A7aV&j)ylXa=QaL8MSgWN%d#4O`u-u;eEU
zCW%EbWF+^wdGs^>emy)k`(&VHEjF8-_FiB-)RW-C9s+$gayO#BFErm0p+EzlqM!Ng
zbQ(Q;nYrseFKp-cRciW9>*HKCy(t#P1Ycg?fQyCAry9qt)h83sTHHz>F;i6q{xqc|
zZ$JSZ{rm0>ogADt>%-~0PLhO3q*(7!DM?w(OMVnoT(RF2+1FjylHv9M0000<MNUMn
GLSTZ!GzU)r

literal 0
HcmV?d00001

diff --git a/doc/ns3_html_theme/static/ns-3-bars-32x32.png b/doc/ns3_html_theme/static/ns-3-bars-32x32.png
new file mode 100644
index 0000000000000000000000000000000000000000..20e68120fd9f15936d0d38a7f97e15921299cdfb
GIT binary patch
literal 1212
zcmV;t1Vj6YP)<h;3K|Lk000e1NJLTq001BW001Be1^@s6b9#F800004XF*Lt006O%
z3;baP0000WV@Og>004R>004l5008;`004mK004C`008P>0026e000+ooVrmw000C>
zNkl<ZSPAV`&5ImG6n|CS)6+e(-$Bt3yahoB5_gqASiR)n2kwHRcTb)KFH1y7>=lxO
z{sEFhZssz}hGdQ4At#X-4H*?l1oak(hJe}4?)H3icRhcv`eVjnHgT5?IV1($UG?g{
z_j_OUs)-(t#}RnsBEX~=&qMJWz`6h~=59fF&|mRdDKe){QDyHmRWOePv$W^|7*K{e
zgy#U{^FIZLpPccprR3lE>Z<>qV3tg~Wk8-^>#c-&5sE{2{^eyF8}s~M{Te;fX~A=c
zsMA%myPJY6%nVF<5OXr}l`-j8pXw&`^ya$Vi|YY--I!)}&j6`xgt>8zyjtvkiun;@
zbty{xWADz~Su>0kQwn-TBEt-JR^1)fK&B)+QZjEWW%cB@{e|%<briJe@jdiGRkcHj
zfJv|~CKf|xSntRHD7QJ5!pa{*?_`>lLkFS_rX;3leHE5Dd_Z=zi*)qhGiJQEoq{m5
z6>V0U{wn}GO3aB)^ociA>j$e<Q8#zXkwQySic7R1lY2%$JZ&_{DZT=Z$1ML6>_bY=
z1p&QQ8_{njn$I?xBTrcUhMay!)lk2CmTVb;Jj_zfY0jR?d8UxaBYsx9YU1uHB?^@V
zPxpE%-4DLo0Pn}oMYsM8HJ|`*T%y3Q`5z%nFQtZ8=2hnltIAMn1W6Hs3_z)Fr!;hH
zv>`jz007!lEG?0`ew}zRV`M+5o}8RgA8y=bst5X2<h?uhLi;qh9XQ?_sOCy<wXK;O
z=0(*n#h;K0K|rY=T3=&ow<vO4uBC=%K|XDL72o?tnrtuhg{T-{E?o6z5yJP`@U2$j
zey-H!-(ZmRW)-cn(}Jkmigq00vc(mecKCIdf2_S|w7H0i_PnYlUQM5et|NG)S!JgL
z;YPlthvL1vLu+m3M#q%5u}0B9w^=&Yq2<fLK7m05{x_iG+8%#z>-y^^pKHW2PUWB>
z%+fe8y7nzEonI#6edfLuORy#Da-b;`-3Da4g_kv+5me!;;OvT;QU())JZi1T(+D&K
zQj-}{K{~R*<XM^=GtsQc7CZi_T#*4y=yJh0Ff}hr_QV3DERjM1sFg`$TtMi&*pu=}
zC8an@t`IM_HkpDN1rvLabWOkAh+DVB0u(`WbOP6xM}g-9h537-C#-%?Q(mo)k&Aul
zd^b(x{3(0J=qo{haJp2hkD^5wx+3(=JDr=*{m1yE(m|c7?T8cN<XgxRtu%wTQSu8o
z1%JVyh56}@Rd)V68l_rr5-cyn(=+qat<NO1u%6{E0DTesu~Pcuxr31f!oI%nvwsZ6
zzonG<#u@1xe|<l71m|4Sd(Ke~bnq1J<`eS=J6}uatr5ad3`^^y5AqDIMQ)Hbupas+
zT=K|;Qz!}Zt~j{Pc}im;oE=d)EWNqZMY$Gw2?B+pyIB86M!@bfO5pqO^>6P)reFRM
ang0u%yuPn1?IHsJ0000<MNUMnLSTZ`s5+GZ

literal 0
HcmV?d00001

diff --git a/wscript b/wscript
index 40e76a4a9..407a05391 100644
--- a/wscript
+++ b/wscript
@@ -242,6 +242,10 @@ def options(opt):
                          'but do not wait for ns-3 to finish the full build.'),
                    action="store_true", default=False,
                    dest='doxygen_no_build')
+    opt.add_option('--docset',
+                   help=('Create Docset, without building. This requires the docsetutil tool from Xcode 9.2 or earlier. See Bugzilla 2196 for more details.'),
+                   action="store_true", default=False,
+                   dest="docset_build")
     opt.add_option('--enable-des-metrics',
                    help=('Log all events in a json file with the name of the executable (which must call CommandLine::Parse(argc, argv)'),
                    action="store_true", default=False,
@@ -1057,6 +1061,10 @@ def build(bld):
         _doxygen(bld)
         raise SystemExit(0)
 
+    if Options.options.docset_build:
+        _docset(bld)
+        raise SystemExit(0)
+
     if Options.options.run_no_build:
         # Check that the requested program name is valid
         program_name, dummy_program_argv = wutils.get_run_program(Options.options.run_no_build, wutils.get_command_template(bld.env))
@@ -1266,6 +1274,65 @@ def _doxygen(bld):
         Logs.error("Doxygen build returned an error.")
         raise SystemExit(1)
 
+def _docset(bld):
+    # Get the doxygen config
+    doxyfile = os.path.join('doc', 'doxygen.conf')
+    Logs.info("docset: reading " + doxyfile)
+    doxygen_config = open(doxyfile, 'r')
+    doxygen_config_contents = doxygen_config.read()
+    doxygen_config.close()
+
+    # Create the output directory
+    docset_path = os.path.join('doc', 'docset')
+    Logs.info("docset: checking for output directory " + docset_path)
+    if not os.path.exists(docset_path):
+        Logs.info("docset: creating output directory " + docset_path)
+        os.mkdir(docset_path)
+
+    doxyfile = os.path.join('doc', 'doxygen.docset.conf')
+    doxygen_config = open(doxyfile, 'w')
+    Logs.info("docset: writing doxygen conf " + doxyfile)
+    doxygen_config.write(doxygen_config_contents)
+    doxygen_config.write(
+        """
+        HAVE_DOT = NO
+        GENERATE_DOCSET = YES
+        DISABLE_INDEX = YES
+        SEARCHENGINE = NO
+        GENERATE_TREEVIEW = NO
+        OUTPUT_DIRECTORY=""" + docset_path + "\n"
+        )
+    doxygen_config.close()
+
+    # Run Doxygen manually, so as to avoid build
+    Logs.info("docset: running doxygen")
+    env = wutils.bld.env
+    _getVersion()
+    if subprocess.Popen(env['DOXYGEN'] + [doxyfile]).wait():
+        Logs.error("Doxygen docset build returned an error.")
+        raise SystemExit(1)
+
+    # Build docset
+    docset_path = os.path.join(docset_path, 'html')
+    Logs.info("docset: Running docset Make")
+    if subprocess.Popen(["make"], cwd=docset_path).wait():
+        Logs.error("Docset make returned and error.")
+        raise SystemExit(1)
+
+    # Additional steps from
+    #   https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/ns-3
+    docset_out = os.path.join(docset_path, 'org.nsnam.ns3.docset')
+    icons = os.path.join('doc', 'ns3_html_theme', 'static')
+    shutil.copy(os.path.join(icons, 'ns-3-bars-16x16.png'),
+                os.path.join(docset_out, 'icon.png'))
+    shutil.copy(os.path.join(icons, 'ns-3-bars-32x32.png'),
+                os.path.join(docset_out, 'icon@x2.png'))
+    shutil.copy(os.path.join(docset_path, 'Info.plist'),
+                os.path.join(docset_out, 'Contents'))
+    shutil.move(docset_out, os.path.join('doc', 'ns-3.docset'))
+
+    print("Docset built successfully.")
+    
 
 def _getVersion():
     """update the ns3_version.js file, when building documentation"""