diff --git a/docs/conf.py b/docs/conf.py index efec020..9fba867 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,6 +16,14 @@ pygments_style = 'sphinx' todo_include_todos = False html_theme = 'alabaster' +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', + 'searchbox.html', + ] +} latex_elements = {} latex_documents = [ diff --git a/docs/contributing.rst b/docs/contributing.rst index a5012e5..c7c215d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -48,7 +48,7 @@ Testing All of the tools mentioned in this section are installed when you run ``pip install -r requirements.txt``. -python-stix2 uses `pytest ` for testing. We encourage the +python-stix2 uses `pytest `_ for testing. We encourage the 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 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``. -All commits pushed to the ``master`` branch or submitted as a pull request is -tested with `Travis-CI ` +All commits pushed to the ``master`` branch or submitted as a pull request are +tested with `Travis-CI `_ automatically. diff --git a/docs/datastore_api.rst b/docs/datastore_api.rst index 1b10c1b..5ecf09f 100644 --- a/docs/datastore_api.rst +++ b/docs/datastore_api.rst @@ -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, which implements the DataStore API while delegating functionality to one or more -"child" data store. +"child" data stores.