doc: fixes to be able to build a PDF files from the tutorials and sho…

…wcases folder

This is useful to have all the examples in a single file.

doc/src/Makefile

@@ -22,7 +22,7 @@ server: Makefile copy-media
 	@sphinx-autobuild --host 0.0.0.0 --port 8000 "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O) -r .git
 	unlink showcases; unlink tutorials
 
-pdf: Makefile copy-media
+pdf: Makefile
 	ln -sf ../../showcases showcases; ln -sf ../../tutorials
 	@$(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	unlink showcases; unlink tutorials

doc/src/conf.py

@@ -48,6 +48,7 @@
     'sphinx.ext.todo',
     'sphinx.ext.githubpages',
     'sphinx.ext.graphviz',
+    'sphinx.ext.imgconverter',
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.viewcode',
@@ -79,7 +80,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -116,6 +117,7 @@
 #    'inet.project',
 #    'inet.scave'
 ]
+
 # To exclude a class, function, method or attribute, use autodoc-skip-member. (Note this can also
 # be used in reverse, ie. to re-include a particular member that has been excluded.)
 # 'Private' and 'special' members (_ and __) are excluded using the Jinja2 templates; from the main
@@ -258,10 +260,10 @@ def autodoc_skip_member_callback(app, what, name, obj, skip, options):
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('users-guide/index', 'users-guide.tex', "INET Framework User's Guide", '', 'manual', False),
-    ('developers-guide/index', 'developers-guide.tex', "INET Framework Developer's Guide", '', 'manual', False),
-    ('tutorials/index', 'tutorials.tex', "tutorials", '', 'article', False),
-    ('showcases/index', 'showcases.tex', "showcases", '', 'article', False),
+    ('users-guide/index', 'inet-users-guide.tex', "INET Framework User's Guide", '', 'manual', False),
+    ('developers-guide/index', 'inet-developers-guide.tex', "INET Framework Developer's Guide", '', 'manual', False),
+    ('showcases/index', 'inet-showcases.tex', "INET Framework Showcases", '', 'manual', False),
+    ('tutorials/index', 'inet-tutorials.tex', "INET Framework Tutorials", '', 'manual', False),
 ]
 
 

doc/src/users-guide/ch-networks.rst

@@ -31,7 +31,7 @@ create one, and because of the vast possibilities. However, the OMNeT++
 IDE provides several topology generator wizards for advanced scenarios.
 
 As INET is an OMNeT++-based framework, users mainly use NED to describe
-the model topology, and ini files to provide configuration. [1]_
+the model topology, and ini files to provide configuration.
 
 .. _ug:sec:networks:built-in-network-nodes-and-other-top-level-modules:
 
@@ -314,6 +314,3 @@ packet forwarding as simply as flipping a switch.
    :end-before: !End
    :name: Forwarding example
 
-.. [1]
-   Some components require additional configuration to be provided as
-   separate files, e.g. in XML.

showcases/wireless/crosstalk/doc/index.rst

@@ -110,7 +110,7 @@ of the contention modules of the transmitting hosts.
   :width: 90%
   :align: center
 
-   <!--internal video recording, animation speed none, playback speed 0.59, zoom 1.69, display message name and message class off, run until #141-->
+   <!--internal video recording, animation speed none, playback speed 0.59, zoom 1.69, display message name and message class off, run until event 141-->
 
 At first the two source nodes, ``host1`` and ``host3``, start
 transmitting at the same time. The transmissions collide, and neither
@@ -145,7 +145,7 @@ The video below shows the hosts communicating:
   :width: 90%
   :align: center
 
-   <!--internal video recoding, animation speed none, playback speed 0.59, zoom 1.69, display message name and message class off, run until #159-->
+   <!--internal video recoding, animation speed none, playback speed 0.59, zoom 1.69, display message name and message class off, run until event 159-->
 
 Since host-pairs communicate on independent channels, there is no
 interference. ``host1`` and ``host3`` can transmit simultaneously, and
@@ -188,7 +188,7 @@ host-pairs communicating:
   :width: 90%
   :align: center
 
-   <!--internal video recording, animation speed none, playback speed 0.59, zoom 1.69, display message name and message class off, run until #129-->
+   <!--internal video recording, animation speed none, playback speed 0.59, zoom 1.69, display message name and message class off, run until event 129-->
 
 The host pairs communicate without interference.
 Notice that there are only message sends between hosts using the same radio medium module.
@@ -225,7 +225,7 @@ The following video shows the host pairs communicating:
    :width: 90%
    :align: center
 
-.. animation speed none, playback speed 0.47, zoom 1.69, run until #84
+.. animation speed none, playback speed 0.47, zoom 1.69, run until event 84
 
 Even though they are on different channels, the transmissions interfere.
 In the beginning, ``host1`` and ``host3`` transmit simultaneously,

tutorials/configurator/doc/step11.rst

@@ -106,7 +106,7 @@ The ping exchanges highlight the modified routes on the following video:
 .. video:: media/Step11B_2_cropped.mp4
    :width: 100%
 
-   <!--from #295 zoom 0.77 playback speed 2.5 animation speed none crop 30 70 150 80-->
+   <!--from event 295 zoom 0.77 playback speed 2.5 animation speed none crop 30 70 150 80-->
 
 The packets travel only counter-clockwise in the triangle of the three
 routers.

tutorials/configurator/doc/step12.rst

@@ -123,7 +123,7 @@ The following video shows ``area1host1`` pinging ``area2host1``:
 .. video:: media/Step12_2_cropped.mp4
    :width: 100%
 
-   <!--internal video recording playback speed 2 animation speed none zoom 1.0 from sendPing(1) to #1734 crop 140 380 150 440-->
+   <!--internal video recording playback speed 2 animation speed none zoom 1.0 from sendPing(1) to event 1734 crop 140 380 150 440-->
 
 Sources: :download:`omnetpp.ini <../omnetpp.ini>`,
 :download:`ConfiguratorE.ned <../ConfiguratorE.ned>`