diff options
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..8255518 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,41 @@ +===================== +netaddr documentation +===================== + +A Python library for representing and manipulating layer 3 (IP) and layer 2 (MAC) +network addresses. + +netaddr's documentation uses the `Diátaxis approach to technical documentation +authoring <https://diataxis.fr/>`_ and is organized like so: + +* :doc:`tutorials` take you on a step-by-step journey through some of the netaddr's features. + Start here if you're new to netaddr. +* :doc:`how-to` are recipes and provide steps to address common problems and use-cases. +* :doc:`reference` contains technical description of various parts of netaddr machinery + (including the :doc:`api`). + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: User documentation + + tutorials + how-to + reference + authors + contributors + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: Developer documentation + + dev-how-to/index + +------------------ +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`search` + |