Merge pull request #1 from oasis-open/documentation

Add navigation to sidebar, fix typos
stix2.1
Greg Back 2017-02-21 09:37:03 -06:00 committed by GitHub
commit abb0257c11
3 changed files with 12 additions and 4 deletions

View File

@ -16,6 +16,14 @@ pygments_style = 'sphinx'
todo_include_todos = False todo_include_todos = False
html_theme = 'alabaster' html_theme = 'alabaster'
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html',
'searchbox.html',
]
}
latex_elements = {} latex_elements = {}
latex_documents = [ latex_documents = [

View File

@ -48,7 +48,7 @@ Testing
All of the tools mentioned in this section are installed when you run ``pip All of the tools mentioned in this section are installed when you run ``pip
install -r requirements.txt``. install -r requirements.txt``.
python-stix2 uses `pytest <http://pytest.org>` for testing. We encourage the python-stix2 uses `pytest <http://pytest.org>`_ for testing. We encourage the
use of test-driven development (TDD), where you write (failing) tests that use of test-driven development (TDD), where you write (failing) tests that
demonstrate a bug or proposed new feature before writing code that fixes the bug demonstrate a bug or proposed new feature before writing code that fixes the bug
or implements the features. Any code contributions to python-stix2 should come or implements the features. Any code contributions to python-stix2 should come
@ -88,6 +88,6 @@ run::
then look at the resulting report in ``htmlcov/index.html``. then look at the resulting report in ``htmlcov/index.html``.
All commits pushed to the ``master`` branch or submitted as a pull request is All commits pushed to the ``master`` branch or submitted as a pull request are
tested with `Travis-CI <https://travis-ci.org/oasis-open/cti-python-stix2>` tested with `Travis-CI <https://travis-ci.org/oasis-open/cti-python-stix2>`_
automatically. automatically.

View File

@ -36,4 +36,4 @@ either explicitly include or exclude results with certain criteria. For example,
Additionally, the python-stix2 library will contain a "composite" data store, Additionally, the python-stix2 library will contain a "composite" data store,
which implements the DataStore API while delegating functionality to one or more which implements the DataStore API while delegating functionality to one or more
"child" data store. "child" data stores.