doc/tutorial/source/index.rst
author Tom Henderson <tomh@tomh.org>
Sat, 16 Jan 2016 08:14:40 -0800
changeset 11683 9142266fbb25
parent 10401 6e9d4ceb880b
permissions -rw-r--r--
add figures to main documentation build
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6754
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     1
.. only:: html or latex
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     2
7251
b2fe610ad03f some tutorial index.rst fixes
Vedran Miletić <rivanvx@gmail.com>
parents: 6770
diff changeset
     3
ns-3 Tutorial
6770
f600bfc2ada9 get rid of some sphinx warnings
Tom Henderson <tomh@tomh.org>
parents: 6764
diff changeset
     4
===========================
6764
3fb0ea261271 fix boilerplates
Tom Henderson <tomh@tomh.org>
parents: 6754
diff changeset
     5
7251
b2fe610ad03f some tutorial index.rst fixes
Vedran Miletić <rivanvx@gmail.com>
parents: 6770
diff changeset
     6
This is the *ns-3 Tutorial*. Primary documentation for the ns-3 project is
7314
7162e24118ea Miscellaneous fixes to Tutorial
Mitch Watrous <watrous@u.washington.edu>
parents: 7251
diff changeset
     7
available in five forms:
6754
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     8
6764
3fb0ea261271 fix boilerplates
Tom Henderson <tomh@tomh.org>
parents: 6754
diff changeset
     9
* `ns-3 Doxygen <http://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
7576
8bf961beb81c Fix documentation links
Tom Henderson <tomh@tomh.org>
parents: 7314
diff changeset
    10
* Tutorial *(this document)*, Manual, and Model Library for the `latest release <http://www.nsnam.org/documentation/latest/>`_ and `development tree <http://www.nsnam.org/ns-3-dev/documentation/>`_
10401
6e9d4ceb880b Update ns-3 wiki URL
Daniel Lertpratchya <nikkipui@gmail.com>
parents: 10186
diff changeset
    11
* `ns-3 wiki <http://www.nsnam.org/wiki/Main_Page>`_
6764
3fb0ea261271 fix boilerplates
Tom Henderson <tomh@tomh.org>
parents: 6754
diff changeset
    12
3fb0ea261271 fix boilerplates
Tom Henderson <tomh@tomh.org>
parents: 6754
diff changeset
    13
This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <http://sphinx.pocoo.org/>`_ and is maintained in the
3fb0ea261271 fix boilerplates
Tom Henderson <tomh@tomh.org>
parents: 6754
diff changeset
    14
``doc/tutorial`` directory of ns-3's source code.
6754
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    15
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    16
.. toctree::
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    17
   :maxdepth: 2
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    18
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    19
   introduction
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    20
   resources
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    21
   getting-started
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    22
   conceptual-overview
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    23
   tweaking
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    24
   building-topologies
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
   tracing
10186
cfbc9491d7e7 add data collection chapter to the tutorial
Tom Henderson <tomh@tomh.org>
parents: 7577
diff changeset
    26
   data-collection
6754
7ff69b244b5b Move tutorial to Sphinx
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    27
   conclusion