51a499cb33
Formatting changes made by the new pre-commit hook 'add trailing commas'
...
closes #189
2018-07-13 11:10:05 -04:00
636630a5aa
Bump version: 1.0.1 → 1.0.2
2018-05-18 13:06:32 -04:00
102623b29a
Bump version: 1.0.0 → 1.0.1
2018-04-27 16:51:47 -04:00
161e10ec40
Bump version: 0.5.1 → 1.0.0
2018-04-16 14:57:35 -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
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
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
ef3ce9f6f0
Bump version: 0.3.0 → 0.4.0
2017-11-13 16:40:58 -05: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
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
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
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
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
084a3cd32a
Add navigation to sidebar, fix typos
2017-02-20 15:38:35 -05:00
610f24fe54
Basic Sphinx site.
2017-02-14 15:56:09 -06:00
Emmanuelle Vargas-Gonzalez