MISP
/
cti-python-stix2
mirror of https://github.com/MISP/cti-python-stix2
2
0
Fork 0
Code Issues Releases Wiki Activity
cti-python-stix2/docs/conf.py

53 lines
1.1 KiB
Python
Raw Normal View History

Set up Sphinx autodoc This will automatically generate API documentation from docstrings.
2017-09-21 23:27:13 +02:00
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
Add sphinx-prompt
2017-04-07 19:10:42 +02:00
extensions = [
'sphinx-prompt',
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 19:29:14 +02:00
'nbsphinx',
Set up Sphinx autodoc This will automatically generate API documentation from docstrings.
2017-09-21 23:27:13 +02:00
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.napoleon',
Improve autodoc output - Add markings and sources - Tidy up some docstrings
2017-09-22 16:01:00 +02:00
'sphinx.ext.todo',
Add sphinx-prompt
2017-04-07 19:10:42 +02:00
]
Set up Sphinx autodoc This will automatically generate API documentation from docstrings.
2017-09-21 23:27:13 +02:00
autodoc_default_flags = [
'undoc-members',
]
autodoc_member_order = 'groupwise'
autosummary_generate = True
napoleon_numpy_docstring = False # Force consistency, leave only Google
napoleon_use_rtype = False
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 17:03:25 +02:00
add_module_names = False
Set up Sphinx autodoc This will automatically generate API documentation from docstrings.
2017-09-21 23:27:13 +02:00
Basic Sphinx site.
2017-02-14 22:48:13 +01:00
templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
project = 'stix2'
copyright = '2017, OASIS Open'
author = 'OASIS Open'
Bump version: 0.2.0 → 0.3.0
2017-10-06 21:40:34 +02:00
version = '0.3.0'
release = '0.3.0'
Basic Sphinx site.
2017-02-14 22:48:13 +01:00
language = None
Add JSON syntax highlighting to docs' output cells Uses a hidden cell in the Jupyter notebook to monkeypatch print.
2017-09-26 20:39:32 +02:00
exclude_patterns = ['_build', '_templates', 'Thumbs.db', '.DS_Store', 'guide/.ipynb_checkpoints']
Basic Sphinx site.
2017-02-14 22:48:13 +01:00
pygments_style = 'sphinx'
todo_include_todos = False
html_theme = 'alabaster'
Add navigation to sidebar, fix typos
2017-02-20 21:38:35 +01:00
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html',
'searchbox.html',
]
}
Basic Sphinx site.
2017-02-14 22:48:13 +01:00
latex_elements = {}
latex_documents = [
(master_doc, 'stix2.tex', 'stix2 Documentation', 'OASIS', 'manual'),
]