a1ad90d43f
Merge pull request #150 from oasis-open/38-workbench
...
Create Workbench layer
2018-04-05 10:09:23 -05:00
a1af05a14e
Warn against using workbench with the rest of lib
...
Doing so may cause issues because the workbench overwrites the STIX
Object mapping.
2018-04-04 09:47:48 -04:00
90834c5b95
docs and tests for parse() mod
2018-03-30 13:21:07 -04:00
4a2ac6df3a
Add/fix workbench docs, rename add() -> save()
2018-03-30 12:04:31 -04:00
b9bbd03481
Update workbench imports and documentation
...
Import a bunch of stuff so users can just "from stix2.workbench import *" and
not need to import other stuff (e.g. MarkingDefinition, Cyber Observable
Object classes, etc.) from stix2.
2018-03-30 12:04:31 -04:00
efede51453
Skip documenting some workbench stuff
2018-03-30 12:04:31 -04:00
198b4ecffa
Tweak property autodocumenter
...
- Skip the 'type' property, since it shouldn't be overridden.
- Add info on default values (currently this is only used for timestamp
properties, setting them to the current time).
- Rename it to STIXPropertyDocumenter since they're called properties in
STIX instead of attributes.
2018-03-16 16:14:21 -04:00
bc72f93424
Add warning about TAXIICollection bug
...
Related: #125 .
2018-03-15 18:07:14 -04:00
955cad8385
Clarify serialization in documentation
2018-03-13 16:01:42 -04:00
f9523f24bf
Bump version: 0.5.0 → 0.5.1
2018-03-06 12:05:53 -05:00
35679e6a6b
Bump version: 0.4.0 → 0.5.0
2018-03-06 11:45:06 -05:00
eb2d87ce71
Rename "DataStore" class to "DataStoreMixin"
...
Fix #116 .
2018-03-01 11:27:37 -05:00
5f703509be
Rename "sources" subpackage to "datastore"
...
Fix #114 .
2018-03-01 09:04:42 -05:00
9402cff110
Merge pull request #131 from oasis-open/taxii_collection_source_404
...
Data source/store/sink changes
2018-02-27 17:04:14 -05:00
57eb709c48
Merge branch 'master' into taxii_collection_source_404
2018-02-26 17:08:28 -05:00
df57f4d159
Fix typos in datasources
2018-02-26 16:56:24 -05:00
aaff2a3a04
Appease pycodestyle
2018-02-22 09:55:15 -05:00
6f35978ba6
Document STIX object properties' metadata
...
(i.e. property type, whether it is required)
2018-02-21 16:46:13 -05:00
3263c3848f
List STIX objects' properties in documentation
2018-02-21 16:46:13 -05:00
f1813f17e0
Fix a couple links in documentation
...
Also upgrade nbsphinx version.
2018-02-21 16:46:13 -05:00
a758c7e1b2
Update datastore.ipynb
2018-01-31 17:24:57 +00:00
126094106e
Merge branch 'master' into taxii_collection_source_404
2017-11-29 22:13:16 +00:00
db9c93d9e1
Add documentation for related object functions
2017-11-21 17:32:17 -05:00
ec42182cb1
issue #107 , also MemorySource.load_from_file() parses JSON into python-stix2 objects now
2017-11-17 12:19:06 -05:00
da4e843993
issue #104 with TAXIICollectionSource tweak
2017-11-16 17:47:27 -05:00
ef3ce9f6f0
Bump version: 0.3.0 → 0.4.0
2017-11-13 16:40:58 -05:00
2dc8a97a51
Fix documentation links for v20
2017-11-13 14:14:24 -05:00
60c3aa0167
Fix redundant Data Markings example
...
To show both uses of get_markings()
2017-11-13 09:44:00 -05:00
7495ea6588
Add inter-documentation links
...
So when users read the guide docs, they can click a link to go to a
relevant section in the API reference.
2017-11-09 15:42:59 -05:00
6f1ab52aa5
Update Jupyter Notebook documentation
2017-11-03 14:22:15 -04:00
a17d770d34
Merge master
2017-11-01 14:17:41 -04:00
06a50b0178
Update README, add DEFAULT_VERSION
2017-11-01 10:48:28 -04:00
ef20860400
Detele support.ipynb
2017-11-01 10:03:03 -04:00
e985d3b1d5
Move ts_support to Jupiter Notebook
2017-11-01 10:01:41 -04:00
d8e4f1ab98
addessing requested changes
2017-10-31 13:48:31 -04:00
b9d25a8375
Add notebook docs, fix package distribution
2017-10-28 00:32:28 -04:00
942a95a4e2
Update documentation
2017-10-27 12:38:25 -04:00
313c6f56ff
guide output
2017-10-25 14:38:25 -04:00
7092990565
tested code with jupyter notebook and local TAXII server
2017-10-25 14:36:20 -04:00
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
Greg Back