Skip to content

Commit 3250f99

Browse files
authored
Merge pull request #103 from oasis-open/70-docs-links
Add inter-documentation links
2 parents ef6dade + 2dc8a97 commit 3250f99

28 files changed

+578
-232
lines changed

docs/api/stix2.common.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/api/stix2.observables.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/api/stix2.sdo.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/api/stix2.sro.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/api/stix2.v20.common.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
common
2+
================
3+
4+
.. automodule:: stix2.v20.common
5+
:members:

docs/api/stix2.v20.observables.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
observables
2+
=====================
3+
4+
.. automodule:: stix2.v20.observables
5+
:members:

docs/api/stix2.v20.sdo.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
sdo
2+
=============
3+
4+
.. automodule:: stix2.v20.sdo
5+
:members:

docs/api/stix2.v20.sro.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
sro
2+
=============
3+
4+
.. automodule:: stix2.v20.sro
5+
:members:

docs/api_ref.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,9 @@ API Reference
44
This section of documentation contains information on all of the classes and
55
functions in the ``stix2`` API, as given by the package's docstrings.
66

7+
.. note::
8+
All the classes and functions detailed in the pages below are importable
9+
directly from `stix2`. See also:
10+
:ref:`How imports will work <guide/ts_support.ipynb#How-imports-will-work>`.
11+
712
.. automodule:: stix2

docs/guide/creating.ipynb

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@
381381
"cell_type": "markdown",
382382
"metadata": {},
383383
"source": [
384-
"To update the properties of an object, see the **Versioning** section."
384+
"To update the properties of an object, see the [Versioning](versioning.ipynb) section."
385385
]
386386
},
387387
{
@@ -500,7 +500,9 @@
500500
"cell_type": "markdown",
501501
"metadata": {},
502502
"source": [
503-
"As with indicators, the ``type``, ``id``, ``created``, and ``modified`` properties will be set automatically if not provided. For Malware objects, the ``labels`` and ``name`` properties must be provided."
503+
"As with indicators, the ``type``, ``id``, ``created``, and ``modified`` properties will be set automatically if not provided. For Malware objects, the ``labels`` and ``name`` properties must be provided.\n",
504+
"\n",
505+
"You can see the full list of SDO classes [here](../api/stix2.v20.sdo.rst)."
504506
]
505507
},
506508
{
@@ -869,9 +871,9 @@
869871
],
870872
"metadata": {
871873
"kernelspec": {
872-
"display_name": "Python 3",
874+
"display_name": "Python 2",
873875
"language": "python",
874-
"name": "python3"
876+
"name": "python2"
875877
},
876878
"language_info": {
877879
"codemirror_mode": {

0 commit comments

Comments
 (0)