.. stix-ramrod documentation master file, created by
   sphinx-quickstart on Tue Sep 30 14:08:10 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to stix-ramrod's documentation!
=======================================

The **stix-ramrod** library provides scripts and APIs for updating STIX and
CybOX XML content.

For more information about STIX, please visit the
`STIX website <http://stix.mitre.org/>`_. For more information about CybOX,
please visit the `CybOX website <http://cybox.mitre.org>`_.

Contents
=========

.. toctree::
   :maxdepth: 2

   installation
   getting_started
   what_gets_updated



API Reference
=============

.. toctree::
   :maxdepth: 2

   api/index
   api/examples

Contributing
============
If a bug is found, a feature is missing, or something just isn't behaving the
way you'd expect it to, please submit an issue to our `tracker`_. If you'd like
to contribute code to our repository, you can do so by issuing a `pull request`_
and we will work with you to try and integrate that code into our repository.

.. _tracker: https://github.com/STIXProject/stix-ramrod/issues
.. _pull request: https://help.github.com/articles/using-pull-requests


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


stix-ramrod |release| Documentation
===================================

The **stix-ramrod** library provides scripts and APIs for updating STIX and
CybOX XML content.

For more information about STIX, please visit the
`STIX website <http://stix.mitre.org/>`_. For more information about CybOX,
please visit the `CybOX website <http://cybox.mitre.org>`_.

Contents
=========

.. toctree::
   :maxdepth: 2

   installation
   getting_started
   what_gets_updated



API Reference
=============

.. toctree::
   :maxdepth: 2

   api/index
   api/examples

Contributing
============
If a bug is found, a feature is missing, or something just isn't behaving the
way you'd expect it to, please submit an issue to our `tracker`_. If you'd like
to contribute code to our repository, you can do so by issuing a `pull request`_
and we will work with you to try and integrate that code into our repository.

.. _tracker: https://github.com/STIXProject/stix-ramrod/issues
.. _pull request: https://help.github.com/articles/using-pull-requests


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Include release in documentation title.
Include release in documentation title.
