Merge pull request #452 from oasis-open/api-reference-for-pattern-eq

Expose API Reference for Pattern Equivalence - ReadTheDocs

docs/api/equivalence/patterns/compare/stix2.equivalence.patterns.compare.comparison.rst

@@ -0,0 +1,5 @@
+comparison
+==============
+
+.. automodule:: stix2.equivalence.patterns.compare.comparison
+   :members:

docs/api/equivalence/patterns/compare/stix2.equivalence.patterns.compare.observation.rst

@@ -0,0 +1,5 @@
+observation
+==============
+
+.. automodule:: stix2.equivalence.patterns.compare.observation
+   :members:

docs/api/equivalence/patterns/transform/stix2.equivalence.patterns.transform.comparison.rst

@@ -0,0 +1,5 @@
+comparison
+==============
+
+.. automodule:: stix2.equivalence.patterns.transform.comparison
+   :members:

docs/api/equivalence/patterns/transform/stix2.equivalence.patterns.transform.observation.rst

@@ -0,0 +1,5 @@
+observation
+==============
+
+.. automodule:: stix2.equivalence.patterns.transform.observation
+   :members:

docs/api/equivalence/patterns/transform/stix2.equivalence.patterns.transform.specials.rst

@@ -0,0 +1,5 @@
+specials
+==============
+
+.. automodule:: stix2.equivalence.patterns.transform.specials
+   :members:

docs/api/equivalence/stix2.equivalence.patterns.rst

@@ -0,0 +1,5 @@
+patterns
+==============
+
+.. automodule:: stix2.equivalence.patterns
+   :members:

docs/api/stix2.equivalence.rst

@@ -0,0 +1,5 @@
+equivalence
+==============
+
+.. automodule:: stix2.equivalence
+   :members:

stix2/__init__.py

@@ -6,6 +6,7 @@
    confidence
    datastore
    environment
+   equivalence
    exceptions
    markings
    parsing

stix2/equivalence/__init__.py

@@ -0,0 +1,9 @@
+"""Python APIs for STIX 2 Semantic Equivalence.
+
+.. autosummary::
+   :toctree: equivalence
+
+   patterns
+
+|
+"""

stix2/equivalence/patterns/__init__.py

@@ -1,3 +1,14 @@
+"""Python APIs for STIX 2 Pattern Semantic Equivalence.
+
+.. autosummary::
+   :toctree: patterns
+
+   compare
+   transform
+
+|
+"""
+
 import stix2
 from stix2.equivalence.patterns.compare.observation import (
     observation_expression_cmp,

stix2/equivalence/patterns/compare/__init__.py

@@ -1,5 +1,13 @@
 """
 Some generic comparison utility functions.
+
+.. autosummary::
+   :toctree: compare
+
+   comparison
+   observation
+
+|
 """
 
 

stix2/equivalence/patterns/transform/__init__.py

@@ -1,5 +1,14 @@
 """
 Generic AST transformation classes.
+
+.. autosummary::
+   :toctree: transform
+
+   comparison
+   observation
+   specials
+
+|
 """