cti-python-stix2/docs/index.rst

38 lines
1.0 KiB
ReStructuredText

.. stix2 documentation master file, created by
sphinx-quickstart on Tue Feb 14 15:36:06 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
STIX 2 Python API Documentation
===============================
.. warning::
Prior to version 1.0, all APIs are considered unstable and subject to change.
Welcome to the STIX 2 Python API's documentation. This library is designed to
help you work with STIX 2 content. For more information about STIX 2, see the
`website <http://cti-tc.github.io>`_ of the OASIS Cyber Threat Intelligence
Technical Committee.
Get started with an `overview <overview.rst>`_ of the library, then take a look
at the `guides and tutorials <guide.rst>`_ to see how to use it. For information
about a specific class or function, see the `API reference <api_ref.rst>`_.
.. toctree::
:maxdepth: 3
:caption: Contents:
overview
guide
api_ref
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`