=
fea2499ae2
forgot to pull doc branch down first, after having merged master into doc branch locally (to get access to DataStore/Filter code
2017-09-29 16:03:48 -04:00
=
6bfa516604
update to guide to match Filter code changes
2017-09-29 15:54:56 -04:00
=
815d0e2794
updating docs
2017-09-29 15:04:00 -04:00
Chris Lenk
0b24dcb373
Add JSON syntax highlighting to docs' output cells
...
Uses a hidden cell in the Jupyter notebook to monkeypatch print.
2017-09-26 19:41:19 -04:00
Chris Lenk
ac97eb8bdc
Add Environment documentation (Jupyter)
...
Has errors, needs #57 .
2017-09-25 16:39:58 -04:00
=
54e917110e
Merge branch 'documentation' of https://github.com/oasis-open/cti-python-stix2 into documentation
2017-09-24 18:15:53 -04:00
=
e2a7b89975
guide docs for DataStore/Source/Sink, Memory, FileSystem, TAXIICollection
2017-09-24 18:14:15 -04:00
=
4450eb545b
mistakenly tweaked output
2017-09-24 15:30:35 -04:00
Chris Lenk
b6d1bb26de
Improve utils docs, rename subpackage docs folders
2017-09-22 14:54:21 -04:00
Chris Lenk
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
Chris Lenk
c0fd740e0a
Improve autodoc output
...
- Add markings and sources
- Tidy up some docstrings
2017-09-22 10:01:00 -04:00
Chris Lenk
d7efd1f752
Set up Sphinx autodoc
...
This will automatically generate API documentation from docstrings.
2017-09-21 17:27:13 -04:00
Chris Lenk
d54ac6e231
Add docs (Jupyter) for custom content
2017-09-21 09:34:02 -04:00
Chris Lenk
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
Chris Lenk
b9a4580a2e
Add Data Markings documentation (Jupyter)
2017-09-15 13:14:54 -04:00
Chris Lenk
efe6912890
Add documentation as Jupyter notebooks
...
- Creating STIX Content
- Serializing STIX Objects
- Parsing STIX Content
- Versioning
2017-09-15 09:53:00 -04:00
Greg Back
2c8efc93bb
Add information on API layers
2017-06-29 12:51:17 +00:00
Greg Back
9dbde93031
Bump version: 0.1.0 → 0.2.0
2017-05-31 10:03:50 -05:00
Greg Back
33cc4caa36
Bump version: 0.0.1 → 0.1.0
2017-05-22 10:18:49 -05:00
Greg Back
60a39964e2
Add sphinx-prompt
2017-04-07 12:10:42 -05:00
Greg Back
bb4e9ed35a
Use RST syntax rather than Markdown :-(
2017-04-07 11:53:06 -05:00
Greg Back
4727ee5cc5
Update setup instructions.
2017-04-07 11:45:44 -05:00
clenk
084a3cd32a
Add navigation to sidebar, fix typos
2017-02-20 15:38:35 -05:00
Greg Back
87330fcf74
Initial documentation.
2017-02-14 17:33:15 -06:00
Greg Back
610f24fe54
Basic Sphinx site.
2017-02-14 15:56:09 -06:00