eac1ce94de
Improve docstrings for Sphinx output
...
Also remove package and module names from classes and functions.
Also remove stix2.base from docs. We hide all private classes and
functions from the docs, so the only thing the documentation for base
included was STIXJSONEncoder.
2017-09-22 11:24:55 -04:00
c0fd740e0a
Improve autodoc output
...
- Add markings and sources
- Tidy up some docstrings
2017-09-22 10:01:00 -04:00
d7efd1f752
Set up Sphinx autodoc
...
This will automatically generate API documentation from docstrings.
2017-09-21 17:27:13 -04:00
d54ac6e231
Add docs (Jupyter) for custom content
2017-09-21 09:34:02 -04:00
c3a1c3dc3a
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.
2017-09-18 13:34:34 -04:00
b9a4580a2e
Add Data Markings documentation (Jupyter)
2017-09-15 13:14:54 -04:00
efe6912890
Add documentation as Jupyter notebooks
...
- Creating STIX Content
- Serializing STIX Objects
- Parsing STIX Content
- Versioning
2017-09-15 09:53:00 -04:00
2c8efc93bb
Add information on API layers
2017-06-29 12:51:17 +00:00
9dbde93031
Bump version: 0.1.0 → 0.2.0
2017-05-31 10:03:50 -05:00
33cc4caa36
Bump version: 0.0.1 → 0.1.0
2017-05-22 10:18:49 -05:00
60a39964e2
Add sphinx-prompt
2017-04-07 12:10:42 -05:00
bb4e9ed35a
Use RST syntax rather than Markdown :-(
2017-04-07 11:53:06 -05:00
4727ee5cc5
Update setup instructions.
2017-04-07 11:45:44 -05:00
084a3cd32a
Add navigation to sidebar, fix typos
2017-02-20 15:38:35 -05:00
87330fcf74
Initial documentation.
2017-02-14 17:33:15 -06:00
610f24fe54
Basic Sphinx site.
2017-02-14 15:56:09 -06:00
Chris Lenk