Commit Graph

15 Commits (d260aa8ebdfc22e579b13810c28b67eb40f53426)

Author SHA1 Message Date
Michael Chisholm c6b2b6fbfa Change the warning in the jupyter notebook for creating content,
regarding name collisions between method and property names, to
not pick on the Mapping methods specifically.  The problem is
more general than that: stix objects have more methods than those.
Instead of listing them all out, a more general statement is
made, that accessing those attributes will result in a bound
method, not a STIX property value.
2020-02-03 16:51:12 -05:00
Michael Chisholm 1cadeaa1c6 Added a warning to creating.ipynb about Mapping attributes: they
can't be used to access STIX object properties.
2020-01-29 16:01:15 -05:00
Kartikey Desai 1bf12221a0 Update _valid_refs doc and add test to v20 test suite 2019-05-13 09:18:50 -04:00
Kartikey Desai 8946308527 Updated documentation for _valid_refs 2019-05-10 12:30:52 -04:00
Kartikey Desai 989f17e673 Add documentation for _valid_refs 2019-05-10 11:54:59 -04:00
Chris Lenk 0ca2bc087a Fix SDO link in docs 2019-02-06 14:27:33 -05:00
mbastian1135 10149b9345 added 'to_pattern()' utility for pattern expressions; more information on patterning guide 2018-08-27 16:21:14 -04:00
Chris Lenk f83d9a56b5 Clean up documentation 2018-04-09 13:29:53 -04:00
Chris Lenk 5791810906 Ensure all guide doc output cells have [Out] label
Fixes #105.
2018-04-05 16:44:44 -04:00
Chris Lenk f1813f17e0 Fix a couple links in documentation
Also upgrade nbsphinx version.
2018-02-21 16:46:13 -05:00
Chris Lenk 2dc8a97a51 Fix documentation links for v20 2017-11-13 14:14:24 -05:00
Chris Lenk 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
Chris Lenk 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
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 d7efd1f752 Set up Sphinx autodoc
This will automatically generate API documentation from docstrings.
2017-09-21 17:27:13 -04:00