Commit Graph

11 Commits (2f58d7888bee999f85179b95ee56d52eee47cc93)

Author SHA1 Message Date
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