Skip to content

Commit

Permalink
added table syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
vsun757 committed Jul 13, 2023
1 parent 9a1bbde commit 4c758b3
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/attacktoexcel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ attackToExcel provides the means by which to convert/extract the ATT&CK STIX dat
overview of the available methods follows.


.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - method name
- arguments
- usage
Expand All @@ -65,6 +69,9 @@ overview of the available methods follows.
stixToDf provides various methods to process and manipulate the STIX data in order to create [Pandas](https://pandas.pydata.org/) DataFrames for
processing. A brief overview of these methods follows.

.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - method name
- arguments
Expand Down
5 changes: 5 additions & 0 deletions docs/collections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ For more information about ATT&CK collections, see the corresponding

**Collections Scripts**


.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - script
- description
* - `index_to_markdown <https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/collections/index_to_markdown.py>`_
Expand Down
8 changes: 8 additions & 0 deletions docs/diffinstix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@ A brief explanation of key pieces can be found below.
* For domain changes, they are broken down by object type, e.g. `techniques` or `mitigations`.
* The following table helps break down the change types that are currently tracked.

.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - field
- type
- description
Expand Down Expand Up @@ -129,6 +133,10 @@ That is because there are a few fields that have been added in some cases depend
For example, objects that are brand new do not have `previous_version` available to them.
The following table lists the extra fields that can be found in objects in the changelog.

.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - Field
- Required
- Type
Expand Down
28 changes: 28 additions & 0 deletions docs/navlayers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,21 @@ and version 4.X layers, upgrading them to version 4.3.

**Manipulator Scripts
.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - script
- description
* - `layerops <https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/manipulators/layerops.py>`_
- Provides a means by which to combine multiple ATT&CK layer objects in customized ways. A further breakdown can be found in the corresponding [section](#layerops.py) below.

**Exporter Scripts
.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - script
- description
* - `to_excel <https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/exporters/to_excel.py>`_
Expand All @@ -59,6 +67,10 @@ and version 4.X layers, upgrading them to version 4.3.

**Generator Scripts
.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - script
- description
* - `overview_generator <https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/generators/overview_generator.py>`_
Expand All @@ -70,6 +82,10 @@ and version 4.X layers, upgrading them to version 4.3.

**Utility Modules
.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - script
- description
* - `excel_templates <https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/exporters/excel_templates.py>`_
Expand All @@ -83,6 +99,10 @@ and version 4.X layers, upgrading them to version 4.3.

**Command Line Tools
.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - script
- description
* - `layerExporter_cli.py <https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/layerExporter_cli.py>`_
Expand All @@ -97,6 +117,10 @@ It is the primary interface through which other Layer-related classes defined in
The Layer class API and a usage example are below.
The class currently supports version 3 and 4 of the ATT&CK Layer spec, and will upgrade version 3 layers into compatible version 4 ones whenever possible.

.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - method [x = Layer()]
- description
* - `x.from_str(_input_)`
Expand Down Expand Up @@ -314,6 +338,10 @@ the currently loaded configuration can be interacted with at `ToSvg().config`.
The configuration can also be populated from a json file using the `.load_from_file(filename="path/to/file.json")` method,
or stored to one using the `.save_to_file(filename="path/to/file.json)` method.

.. list-table:: Title
:widths: 25 25 50
:header-rows: 1

* - attribute
- description
- type
Expand Down

0 comments on commit 4c758b3

Please sign in to comment.