doc: Update and align all document indices

This commit is contained in:
Tom Henderson
2023-03-02 19:45:38 -08:00
parent c7e002558b
commit 451399082a
5 changed files with 69 additions and 34 deletions

View File

@@ -1,17 +1,26 @@
.. only:: html or latex
ns-3 Tutorial
===========================
=============
This is the *ns-3 Tutorial*. Primary documentation for the ns-3 project is
available in five forms:
This is the *ns-3 Tutorial*. Primary documentation for the ns-3 project is organized as
follows:
* `ns-3 Doxygen <https://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
* Tutorial *(this document)*, Manual, and Model Library for the `latest release <https://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/development-tree/>`_
* `ns-3 wiki <https://www.nsnam.org/wiki>`_
* Several guides that are version controlled for each release (the
`latest release <https://www.nsnam.org/documentation/latest/>`_) and
`development tree <https://www.nsnam.org/ns-3-dev/documentation/>`_:
* Tutorial *(this document)*
* Installation Guide
* Manual
* Model Library
* Contributing Guide
* `ns-3 Doxygen <https://www.nsnam.org/docs/doxygen/index.html>`_: Documentation of the public APIs of
the simulator
* `ns-3 wiki <https://www.nsnam.org/wiki/Main_Page>`_
This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <https://www.sphinx-doc.org/>`_ and is maintained in the
``doc/tutorial`` directory of ns-3's source code.
``doc/tutorial`` directory of ns-3's source code. Source file column width is 100 columns.
.. toctree::
:maxdepth: 2