Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sébastien Diemer committed Feb 21, 2018
1 parent 41d00fb commit b74e968
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ History
* Made CID repsonse header configurable, and optional (thanks @dbaty)

0.2.0 (2016-12-06)
+++++++++++++++++
++++++++++++++++++

* Added support for Django 1.10 middleware (thanks @qbey)
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ is quite a simple one. Incoming requests are assigned a unique id (a uuid).
This can either happen in say your public facing web server (e.g. nginx) or be
applied as soon as it hits django.

This ``cid`` is then available throught the django request/response cycle. We
This ``cid`` is then available through the django request/response cycle. We
provide filters for logging witch adds the ``cid`` to the logging record so you
can add it to your formatting string. We also provide wrappers around all the
standard database backends which adds the ``cid`` as a comment before each SQL
Expand All @@ -31,7 +31,7 @@ Features
* Processing/Generation of a correlation id
* Database wrappers to add correlation id to each sql call
* Logging filter to inject the correlation id into logs
* A template context processe to make correlation id available in templates
* A template context processor to make correlation id available in templates
* Output correlation id as a header

Documentation can be found at: http://django-correlation-id.readthedocs.org/
6 changes: 5 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,8 @@
#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
#texinfo_no_detailmenu = False

# Make autodoc work with Django
os.environ['DJANGO_SETTINGS_MODULE'] = 'sandbox.settings'
suppress_warnings = ['image.not_readable']
4 changes: 3 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ deps =
[testenv:docs]
changedir = docs
deps =
Sphinx==1.2.2
Sphinx==1.7.0
-r{toxinidir}/requirements/ci.txt
django>=1.8,<1.9
commands =
sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html

0 comments on commit b74e968

Please sign in to comment.