Skip to content

Commit 03896db

Browse files
imjonsnooowimjonsnooow
committed
Create API doc structure. Probably needs some reworking/reduction for ideal structuring.
1 parent d321905 commit 03896db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+1345
-0
lines changed

‎docs/api/base.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:mod:`stix.base` Module
2+
==================================
3+
4+
.. module:: stix.base
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: Entity
10+
:members:
11+
12+
.. autoclass:: EntityList
13+
:show-inheritance:
14+
:members:

‎docs/api/campaign/campaign.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
:mod:`stix.campaign` Module
2+
==================================
3+
4+
.. module:: stix.campaign
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: Campaign
10+
:show-inheritance:
11+
:members:
12+
13+
.. autoclass:: AssociatedCampaigns
14+
:show-inheritance:
15+
:members:
16+
17+
.. autoclass:: Attribution
18+
:show-inheritance:
19+
:members:
20+
21+
.. autoclass:: Names
22+
:show-inheritance:
23+
:members:
24+
25+
.. autoclass:: RelatedIncidents
26+
:show-inheritance:
27+
:members:
28+
29+
.. autoclass:: RelatedIndicators
30+
:show-inheritance:
31+
:members:
32+
33+
.. autoclass:: RelatedTTPs
34+
:show-inheritance:
35+
:members:

‎docs/api/coa/coa.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:mod:`stix.coa` Module
2+
==================================
3+
4+
.. module:: stix.coa
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: CourseOfAction
10+
:show-inheritance:
11+
:members:
12+
13+
.. autoclass:: RelatedCOAs
14+
:show-inheritance:
15+
:members:

‎docs/api/coa/objective.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:mod:`stix.coa.objective` Module
2+
==================================
3+
4+
.. module:: stix.coa.objective
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: Objective
10+
:show-inheritance:
11+
:members:

‎docs/api/common/activity.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:mod:`stix.common.activity` Module
2+
==================================
3+
4+
.. module:: stix.common.activity
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: Activity
10+
:show-inheritance:
11+
:members:

‎docs/api/common/common.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:mod:`stix.common` Module
2+
==================================
3+
4+
.. module:: stix.common
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: EncodedCDATA
10+
:show-inheritance:
11+
:members:

‎docs/api/common/confidence.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:mod:`stix.common.confidence` Module
2+
====================================
3+
4+
.. module:: stix.common.confidence
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: Confidence
10+
:show-inheritance:
11+
:members:
12+
13+
.. autoclass:: ConfidenceAssertionChain
14+
:show-inheritance:
15+
:members:

‎docs/api/common/datetimewithprecision.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
:mod:`stix.common.datetimewithprecision` Module
2+
===============================================
3+
4+
.. module:: stix.common.datetimewithprecision
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: DateTimeWithPrecision
10+
:show-inheritance:
11+
:members:
12+
13+
Constants
14+
---------
15+
16+
.. autodata:: DATE_PRECISION_VALUES
17+
18+
.. autodata:: TIME_PRECISION_VALUES
19+
20+
.. autodata:: DATETIME_PRECISION_VALUES

‎docs/api/common/identity.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:mod:`stix.common.identity` Module
2+
==================================
3+
4+
.. module:: stix.common.identity
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: Identity
10+
:show-inheritance:
11+
:members:
12+
13+
.. autoclass:: RelatedIdentities
14+
:show-inheritance:
15+
:members:
16+
17+
Functions
18+
---------
19+
20+
.. autofunction:: add_extension
21+
22+
Constants
23+
---------
24+
25+
.. autodata:: _EXTENSION_MAP

‎docs/api/common/information_source.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:mod:`stix.common.information_source` Module
2+
============================================
3+
4+
.. module:: stix.common.information_source
5+
6+
Classes
7+
-------
8+
9+
.. autoclass:: InformationSource
10+
:show-inheritance:
11+
:members:
12+
13+
.. autoclass:: ContributingSources
14+
:show-inheritance:
15+
:members:

0 commit comments

Comments
 (0)