MISP
/
cti-python-stix2
mirror of https://github.com/MISP/cti-python-stix2
2
0
Fork 0
Code Issues Releases Wiki Activity

Include IPython notebooks in Sphinx docs 

Note: The first cell in each .ipynb file contains code to suppress
tracebacks in output cells. Thus cells that generate exceptions will
only output the error, without the traceback, which makes the
documentation easier to read.
stix2.1
Chris Lenk 2017-09-18 13:29:14 -04:00
parent b9a4580a2e
commit c3a1c3dc3a
9 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/conf.py
View File

@ -1,5 +1,6 @@
extensions = [ extensions = [
'sphinx-prompt', 'sphinx-prompt',
'nbsphinx',
] ]
templates_path = ['_templates'] templates_path = ['_templates']
source_suffix = '.rst' source_suffix = '.rst'

3
docs/creating.ipynb
View File

@ -4,7 +4,8 @@
"cell_type": "code", "cell_type": "code",
"execution_count": 7, "execution_count": 7,
"metadata": { "metadata": {
"collapsed": true "collapsed": true,
"nbsphinx": "hidden"
}, },
"outputs": [], "outputs": [],
"source": [ "source": [

7
docs/index.rst
View File

@ -11,8 +11,13 @@ Welcome to stix2's documentation!
:caption: Contents: :caption: Contents:
overview overview
roadmap creating
serializing
parsing
versioning
markings
datastore_api datastore_api
roadmap
contributing contributing

3
docs/markings.ipynb
View File

@ -4,7 +4,8 @@
"cell_type": "code", "cell_type": "code",
"execution_count": 1, "execution_count": 1,
"metadata": { "metadata": {
"collapsed": true "collapsed": true,
"nbsphinx": "hidden"
}, },
"outputs": [], "outputs": [],
"source": [ "source": [

2
docs/overview.rst
View File

@ -66,7 +66,7 @@ The **Environment Layer** adds several components that make it easier to handle
STIX 2 data as part of a larger application and as part of a larger cyber threat STIX 2 data as part of a larger application and as part of a larger cyber threat
intelligence ecosystem. intelligence ecosystem.
- ``Data Source``s represent locations from which STIX data can be retrieved, - ``Data Source``\s represent locations from which STIX data can be retrieved,
such as a TAXII server, database, or local filesystem. The Data Source API such as a TAXII server, database, or local filesystem. The Data Source API
abstracts differences between these storage location, giving a common API to abstracts differences between these storage location, giving a common API to
get objects by ID or query by various properties, as well as allowing get objects by ID or query by various properties, as well as allowing

3
docs/parsing.ipynb
View File

@ -4,7 +4,8 @@
"cell_type": "code", "cell_type": "code",
"execution_count": 2, "execution_count": 2,
"metadata": { "metadata": {
"collapsed": true "collapsed": true,
"nbsphinx": "hidden"
}, },
"outputs": [], "outputs": [],
"source": [ "source": [

3
docs/serializing.ipynb
View File

@ -4,7 +4,8 @@
"cell_type": "code", "cell_type": "code",
"execution_count": 2, "execution_count": 2,
"metadata": { "metadata": {
"collapsed": true "collapsed": true,
"nbsphinx": "hidden"
}, },
"outputs": [], "outputs": [],
"source": [ "source": [

3
docs/versioning.ipynb
View File

@ -4,7 +4,8 @@
"cell_type": "code", "cell_type": "code",
"execution_count": 5, "execution_count": 5,
"metadata": { "metadata": {
"collapsed": true "collapsed": true,
"nbsphinx": "hidden"
}, },
"outputs": [], "outputs": [],
"source": [ "source": [

1
requirements.txt
View File

@ -1,4 +1,5 @@
bumpversion bumpversion
nbsphinx
pre-commit pre-commit
pytest pytest
pytest-cov pytest-cov