3c80e5e7eb
Update Environment/Workbench layer progress
2017-10-06 16:10:36 -04:00
51361216e9
Bump version: 0.2.0 → 0.3.0
2017-10-06 15:40:34 -04:00
8b702c6985
Minor API docs improvements
...
- Hide "Bases" below class signatures
- Leave some empty space after tables
2017-10-05 20:44:58 -04:00
9c7f49688f
Improve consistency across guide docs
2017-10-05 20:21:11 -04:00
ec34aa952f
Merge branch 'documentation' of https://github.com/oasis-open/cti-python-stix2 into documentation
2017-10-04 15:59:04 -04:00
f7c17d0c07
some progress on CompositeDS guide, but includes some bug fixes in the DataSource API
2017-10-04 15:57:38 -04:00
1c9a16ea77
Update markings docs with latest update
2017-10-04 11:05:33 -04:00
6ccea9bb2e
Default to Py3 kernel in Jupyter notebooks
...
If no matching kernelspec is found a kernel with a matching `language`
("python") will be used
(https://ipython.org/ipython-doc/3/development/kernels.html ).
2017-10-04 09:08:53 -04:00
a0c0e957ff
CompositeDataSource guide - still incomplete as need to test execution
2017-10-02 17:33:03 -04:00
2321e8d54e
taxii guide doc
2017-10-02 16:36:30 -04:00
d737670210
Touch up enrivonment guide docs
...
based on recent DataStore bugfixes.
2017-10-02 09:24:21 -04:00
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
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
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
b6d1bb26de
Improve utils docs, rename subpackage docs folders
2017-09-22 14:54:21 -04:00
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