Commit Graph

34 Commits (fe28f355dcdb1a3bd76e018e9ac2bc27dea4655c)

Author SHA1 Message Date
Emmanuelle Vargas-Gonzalez 72a12e96ba update guide example, conf.py and remove some unused imports 2021-03-01 13:14:03 -05:00
Emmanuelle Vargas-Gonzalez ff5014c606 expose configuration options, combine weight dictionary, update tests 2021-03-01 12:27:52 -05:00
Chris Lenk b7b1b54afb Remove 'six' from config 2021-02-18 23:39:24 -05:00
Emmanuelle Vargas-Gonzalez fc600df5f1 update .gitignore and conf.py 2020-10-16 16:43:12 -04:00
Chris Lenk 77eda29471 Add default weight_dict to documentation
for semantic equivalence
2019-12-11 13:13:36 -05:00
Emmanuelle Vargas-Gonzalez f12cc82d8a incorporate feedback
update documentation for core.py and automatic copyright year for docs
2018-12-11 13:22:04 -05:00
Emmanuelle Vargas-Gonzalez 7aad97307e use stix2 version to update documentation 2018-11-28 09:20:26 -05:00
Emmanuelle Vargas-Gonzalez 5abe518b8a Bump version: 1.0.3 → 1.1.0 2018-11-01 09:55:37 -04:00
Emmanuelle Vargas-Gonzalez eff5369670 Merge branch 'master' of github.com:oasis-open/cti-python-stix2 into stix2.1 2018-11-01 07:57:09 -04:00
Emmanuelle Vargas-Gonzalez f85f4e566b Bump version: 1.0.2 → 1.0.3 2018-10-31 13:46:47 -04:00
Emmanuelle Vargas-Gonzalez 51a499cb33 Formatting changes made by the new pre-commit hook 'add trailing commas'
closes #189
2018-07-13 11:10:05 -04:00
Chris Lenk 636630a5aa Bump version: 1.0.1 → 1.0.2 2018-05-18 13:06:32 -04:00
Chris Lenk 102623b29a Bump version: 1.0.0 → 1.0.1 2018-04-27 16:51:47 -04:00
Chris Lenk 161e10ec40 Bump version: 0.5.1 → 1.0.0 2018-04-16 14:57:35 -04:00
Chris Lenk efede51453 Skip documenting some workbench stuff 2018-03-30 12:04:31 -04:00
Chris Lenk 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
Chris Lenk f9523f24bf Bump version: 0.5.0 → 0.5.1 2018-03-06 12:05:53 -05:00
Chris Lenk 35679e6a6b Bump version: 0.4.0 → 0.5.0 2018-03-06 11:45:06 -05:00
Chris Lenk aaff2a3a04 Appease pycodestyle 2018-02-22 09:55:15 -05:00
Chris Lenk 6f35978ba6 Document STIX object properties' metadata
(i.e. property type, whether it is required)
2018-02-21 16:46:13 -05:00
Chris Lenk 3263c3848f List STIX objects' properties in documentation 2018-02-21 16:46:13 -05:00
Chris Lenk ef3ce9f6f0 Bump version: 0.3.0 → 0.4.0 2017-11-13 16:40:58 -05:00
Chris Lenk 51361216e9 Bump version: 0.2.0 → 0.3.0 2017-10-06 15:40:34 -04:00
Chris Lenk 8b702c6985 Minor API docs improvements
- Hide "Bases" below class signatures
- Leave some empty space after tables
2017-10-05 20:44:58 -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 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 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
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
clenk 084a3cd32a Add navigation to sidebar, fix typos 2017-02-20 15:38:35 -05:00
Greg Back 610f24fe54 Basic Sphinx site. 2017-02-14 15:56:09 -06:00