Update docstrings to relocate links\documentation

2019-01-11 13:55:05 -05:00 · 2019-01-11 13:55:05 -05:00 · db5f8f2ebf
parent e1356437fc
commit db5f8f2ebf
13 changed files with 28 additions and 62 deletions
--- a/docs/api/stix2.v20.bundle.rst
+++ b/docs/api/stix2.v20.bundle.rst
@ -1,5 +0,0 @@
-bundle
-================
-
-.. automodule:: stix2.v20.bundle
-   :members:
--- a/docs/api/stix2.v20.common.rst
+++ b/docs/api/stix2.v20.common.rst
@ -1,5 +0,0 @@
-common
-================
-
-.. automodule:: stix2.v20.common
-   :members:
--- a/docs/api/stix2.v20.observables.rst
+++ b/docs/api/stix2.v20.observables.rst
@ -1,5 +0,0 @@
-observables
-=====================
-
-.. automodule:: stix2.v20.observables
-   :members:
--- a/docs/api/stix2.v20.sdo.rst
+++ b/docs/api/stix2.v20.sdo.rst
@ -1,5 +0,0 @@
-sdo
-=============
-
-.. automodule:: stix2.v20.sdo
-   :members:
--- a/docs/api/stix2.v20.sro.rst
+++ b/docs/api/stix2.v20.sro.rst
@ -1,5 +0,0 @@
-sro
-=============
-
-.. automodule:: stix2.v20.sro
-   :members:
--- a/docs/api/stix2.v21.bundle.rst
+++ b/docs/api/stix2.v21.bundle.rst
@ -1,5 +0,0 @@
-bundle
-================
-
-.. automodule:: stix2.v21.bundle
-   :members:
--- a/docs/api/stix2.v21.common.rst
+++ b/docs/api/stix2.v21.common.rst
@ -1,5 +0,0 @@
-common
-================
-
-.. automodule:: stix2.v21.common
-   :members:
--- a/docs/api/stix2.v21.observables.rst
+++ b/docs/api/stix2.v21.observables.rst
@ -1,5 +0,0 @@
-observables
-=====================
-
-.. automodule:: stix2.v21.observables
-   :members:
--- a/docs/api/stix2.v21.sdo.rst
+++ b/docs/api/stix2.v21.sdo.rst
@ -1,5 +0,0 @@
-sdo
-=============
-
-.. automodule:: stix2.v21.sdo
-   :members:
--- a/docs/api/stix2.v21.sro.rst
+++ b/docs/api/stix2.v21.sro.rst
@ -1,5 +0,0 @@
-sro
-=============
-
-.. automodule:: stix2.v21.sro
-   :members:
--- a/stix2/init.py
+++ b/stix2/init.py
@ -12,16 +12,8 @@
   patterns
   properties
   utils
-   v20.bundle
-   v20.common
-   v20.observables
-   v20.sdo
-   v20.sro
-   v21.bundle
-   v21.common
-   v21.observables
-   v21.sdo
-   v21.sro
+   v20
+   v21
   workbench

 """
--- a/stix2/v20/init.py
+++ b/stix2/v20/init.py
@ -1,4 +1,16 @@
-"""STIX 2.0 API Objects."""
+"""STIX 2.0 API Objects.
+
+.. autosummary::
+   :toctree: v20
+
+   bundle
+   common
+   observables
+   sdo
+   sro
+
+|
+"""

 # flake8: noqa

--- a/stix2/v21/init.py
+++ b/stix2/v21/init.py
@ -1,4 +1,16 @@
-"""STIX 2.1 API Objects."""
+"""STIX 2.1 API Objects.
+
+.. autosummary::
+   :toctree: v21
+
+   bundle
+   common
+   observables
+   sdo
+   sro
+
+|
+"""

 # flake8: noqa