.. only:: html or latex

Contributing to ns-3
====================

This is the guide to *Contributing to ns-3*. Primary documentation for the ns-3 project is available in several forms:

* `ns-3 Doxygen <http://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
* Tutorial for the `latest release <http://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/>`_
* Contributing to ns-3 (this document)
* Manual, and Model Library for the `latest release <http://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/>`_
* `ns-3 wiki <http://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/contributing`` directory of ns-3's source code.

.. toctree::
   :maxdepth: 2

   introduction
   general
   enhancements
   models
   external
   coding-style
