Initial Update

[pyup-bot]

This is my first visit to this fine repo so I have bundled all updates in a single pull request to make things easier for you to merge.

Close this pull request and delete the branch if you want me to start with single pull requests right away

Here's the executive summary:

Updates

Here's a list of all the updates bundled in this pull request. I've added some links to make it easier for you to find all the information you need.

gunicorn	19.7.1	»	19.7.1	PyPI | Changelog | Homepage
Sphinx	1.6.4	»	1.6.4	PyPI | Changelog | Homepage
doc8	0.8.0	»	0.8.0	PyPI | Homepage
flake8	3.4.1	»	3.4.1	PyPI | Changelog | Repo
pyramid	1.9.1	»	1.9.1	PyPI | Changelog | Homepage
pytest	3.2.2	»	3.2.2	PyPI | Changelog | Repo | Homepage
pytest-cov	2.5.1	»	2.5.1	PyPI | Changelog | Repo

Changelogs

gunicorn -> 19.7.1

19.7.1

===================

• fix: continue if SO_REUSEPORT seems to be available but fails (:issue:1480)
• fix: support non-decimal values for the umask command line option (:issue:1325)

19.7.0

===================

• The previously deprecated gunicorn_django command has been removed.
  Use the :ref:gunicorn-cmd command-line interface instead.
• The previously deprecated django_settings setting has been removed.
  Use the :ref:raw-env setting instead.
• The default value of :ref:ssl-version has been changed from
  ssl.PROTOCOL_TLSv1 to ssl.PROTOCOL_SSLv23.
• fix: initialize the group access list when initgroups is set (:issue:1297)
• add environment variables to gunicorn access log format (:issue:1291)
• add --paste-global-conf option (:issue:1304)
• fix: print access logs to STDOUT (:issue:1184)
• remove upper limit on max header size config (:issue:1313)
• fix: print original exception on AppImportError (:issue:1334)
• use SO_REUSEPORT if available (:issue:1344)
• fix leak <https://github.com/benoitc/gunicorn/commit/b4c41481e2d5ef127199a4601417a6819053c3fd>_ of duplicate file descriptor for bound sockets.
• add --reload-engine option, support inotify and other backends (:issue:1368, :issue:1459)
• fix: reject request with invalid HTTP versions
• add child_exit callback (:issue:1394)
• add support for eventlets _AlreadyHandled object (:issue:1406)
• format boot tracebacks properly with reloader (:issue:1408)
• refactor socket activation and fd inheritance for better support of SystemD (:issue:1310)
• fix: o fds are given by default in gunicorn (:issue:1423)
• add ability to pass settings to GUNICORN_CMD_ARGS environment variable which helps in container world (:issue:1385)
• fix: catch access denied to pid file (:issue:1091)
• many additions and improvements to the documentation

Breaking Change
+++++++++++++++

• Python 2.6.0 is the last supported version

19.6.0

===================

Core & Logging
++++++++++++++

• improvement of the binary upgrade behaviour using USR2: remove file locking (:issue:1270)
• add the --capture-output setting to capture stdout/stderr tot the log
  file (:issue:1271)
• Allow disabling sendfile() via the SENDFILE environment variable
  (:issue:1252)
• fix reload under pycharm (:issue:1129)

Workers
+++++++

• fix: make sure to remove the signal from the worker pipe (:issue:1269)
• fix: gthread worker, handle removed socket in the select loop
  (:issue:1258)

19.5.0

===================

Core
++++

• fix: Ensure response to HEAD request won't have message body
• fix: lock domain socket and remove on last arbiter exit (:issue:1220)
• improvement: use EnvironmentError instead of socket.error (:issue:939)
• add: new FORWARDDED_ALLOW_IPS environment variable (:issue:1205)
• fix: infinite recursion when destroying sockets (:issue:1219)
• fix: close sockets on shutdown (:issue:922)
• fix: clean up sys.exc_info calls to drop circular refs (:issue:1228)
• fix: do post_worker_init after load_wsgi (:issue:1248)

Workers
+++++++

• fix access logging in gaiohttp worker (:issue:1193)
• eventlet: handle QUIT in a new coroutine (:issue:1217)
• gevent: remove obsolete exception clauses in run (:issue:1218)
• tornado: fix extra "Server" response header (:issue:1246)
• fix: unblock the wait loop under python 3.5 in sync worker (:issue:1256)

Logging
+++++++

• fix: log message for listener reloading (:issue:1181)
• Let logging module handle traceback printing (:issue:1201)
• improvement: Allow configuring logger_class with statsd_host (:issue:1188)
• fix: traceback formatting (:issue:1235)
• fix: print error logs on stderr and access logs on stdout (:issue:1184)

Documentation
+++++++++++++

• Simplify installation instructions in gunicorn.org (:issue:1072)
• Fix URL and default worker type in example_config (:issue:1209)
• update django doc url to 1.8 lts (:issue:1213)
• fix: miscellaneous wording corrections (:issue:1216)
• Add PSF License Agreement of selectors.py to NOTICE (:issue: 1226)
• document LOGGING overriding (:issue:1051)
• put a note that error logs are only errors from Gunicorn (:issue:1124)
• add a note about the requirements of the threads workers under python 2.x (:issue:1200)
• add access_log_format to config example (:issue:1251)

Tests
+++++

• Use more pytest.raises() in test_http.py

19.4.5

===================

• fix: NameError fileno in gunicorn.http.wsgi (:issue:1178)

19.4.4

===================

• fix: check if a fileobject can be used with sendfile(2) (:issue:1174)
• doc: be more descriptive in errorlog option (:issue:1173)

================
Changelog - 2017

.. note::

Please see :doc:news for the latest changes

19.4.3

===================

• fix: don't check if a file is writable using os.stat with SELINUX (:issue:1171)

19.4.2

===================

Core
++++

• improvement: handle HaltServer in manage_workers (:issue:1095)
• fix: Do not rely on sendfile sending requested count (:issue:1155)
• fix: claridy --no-sendfile default (:issue:1156)
• fix: LoggingCatch sendfile failure from no file descriptor (:issue:1160)

Logging
+++++++

• fix: Always send access log to syslog if syslog is on
• fix: check auth before trying to own a file (:issue:1157)

Documentation
+++++++++++++

• fix: Fix Slowloris broken link. (:issue:1142)
• Tweak markup in faq.rst

Testing
+++++++

• fix: gaiohttp test (:issue:1164)

19.4.1

===================

• fix tornado worker (:issue:1154)

19.4.0 / 2015/11/20

Core
++++

• fix: make sure that a user is able to access to the logs after dropping a
  privilege (:issue:1116)
• improvement: inherit the Exception class where it needs to be (:issue:997)
• fix: make sure headers are always encoded as latin1 RFC 2616 (:issue:1102)
• improvement: reduce arbiter noise (:issue:1078)
• fix: don't close the unix socket when the worker exit (:issue:1088)
• improvement: Make last logged worker count an explicit instance var (:issue:1078)
• improvement: prefix config file with its type (:issue:836)
• improvement: pidfile handing (:issue:1042)
• fix: catch OSError as well as ValueError on race condition (:issue:1052)
• improve support of ipv6 by backporting urlparse.urlsplit from Python 2.7 to
  Python 2.6.
• fix: raise InvalidRequestLine when the line contains malicious data
  (:issue:1023)
• fix: fix argument to disable sendfile
• fix: add gthread to the list of supported workers (:issue:1011)
• improvement: retry socket binding up to five times upon EADDRNOTAVAIL
  (:issue:1004)
• breaking change: only honor headers that can be encoded in ascii to comply to
  the RFC 7230 (See :issue:1151).

Logging
+++++++

• add new parameters to access log (:issue:1132)
• fix: make sure that files handles are correctly reopened on HUP
  (:issue:627)
• include request URL in error message (:issue:1071)
• get username in access logs (:issue:1069)
• fix statsd logging support on Python 3 (:issue:1010)

Testing
+++++++

• use last version of mock.
• many fixes in Travis CI support
• miscellaneous improvements in tests

Thread worker
+++++++++++++

• fix: Fix self.nr usage in ThreadedWorker so that auto restart works as
  expected (:issue:1031)

Gevent worker
+++++++++++++

• fix quit signal handling (:issue:1128)
• add support for Python 3 (:issue:1066)
• fix: make graceful shutdown thread-safe (:issue:1032)

Tornado worker
++++++++++++++

• fix ssl options (:issue:1146, :issue:1135)
• don't check timeout when stopping gracefully (:issue:1106)

AIOHttp worker
++++++++++++++

• add SSL support (:issue:1105)

Documentation
+++++++++++++

• fix link to proc name setting (:issue:1144)
• fix worker class documentation (:issue:1141, :issue:1104)
• clarify graceful timeout documentation (:issue:1137)
• don't duplicate NGINX config files examples (:issue:1050, :issue:1048)
• add web.py framework example (:issue:1117)
• update Debian/Ubuntu installations instructions (:issue:1112)
• clarify pythonpath setting description (:issue:1080)
• tweak some example for python3
• clarify sendfile documentation
• miscellaneous typos in source code comments (thanks!)
• clarify why REMOTE_ADD may not be the user's IP address (:issue:1037)

Misc
++++

• fix: reloader should survive SyntaxError (:issue:994)
• fix: expose the reloader class to the worker.

19.3.0

===================

Changes

Core
++++

• fix: :issue:978 make sure a listener is inheritable
• add check_config class method to workers
• fix: :issue:983 fix select timeout in sync worker with multiple
  connections
• allows workers to access to the reloader. close :issue:984
• raise TypeError instead of AssertionError

Logging
+++++++

• make Logger.loglevel a class attribute

Documentation
+++++++++++++

• fix: :issue:988 fix syntax errors in examples/gunicorn_rc

19.2.1

==================

Changes

Logging
+++++++

• expose loglevel in the Logger class

AsyncIO worker (gaiohttp)
+++++++++++++++++++++++++

• fix :issue:977 fix initial crash

Documentation
+++++++++++++

• document security mailing-list in the contributing page.

19.2

=================

Changes

Core
++++

• optimize the sync workers when listening on a single interface
• add --sendfile settings to enable/disable sendfile. fix :issue:856 .
• add the selectors module to the code base. :issue:886
• add --max-requests-jitter setting to set the maximum jitter to add to the
  max-requests setting.
• fix :issue:899 propagate proxy_protocol_info to keep-alive requests
• fix :issue:863 worker timeout: dynamic timeout has been removed
• fix: Avoid world writable file

Logging
+++++++

• fix :issue:941 set logconfig default to paster more trivially
• add statsd-prefix config setting: set the prefix to use when emitting statsd
  metrics
• :issue:832 log to console by default

Thread Worker
+++++++++++++

• fix :issue:908 make sure the worker can continue to accept requests

Eventlet Worker
+++++++++++++++

• fix :issue:867 Fix eventlet shutdown to actively shut down the workers.

Documentation
+++++++++++++

Many improvements and fixes have been done, see the detailed changelog for
more information.

================
Changelog - 2016

.. note::

Please see :doc:news for the latest changes

19.1.1

===================

Changes

Core
++++

• fix :issue:835: display correct pid of already running instance
• fix :pr:833: fix PyTest class in setup.py.

Logging
+++++++

• fix :issue:838: statsd logger, send statsd timing metrics in milliseconds
• fix :issue:839: statsd logger, allows for empty log message while pushing
  metrics and restore worker number in DEBUG logs
• fix :issue:850: add timezone to logging
• fix :issue:853: Respect logger_class setting unless statsd is on

AioHttp worker
++++++++++++++

• fix :issue:830 make sure gaiohttp worker is shipped with gunicorn.

19.1

=================

Changes

Core
++++

• fix :issue:785: handle binary type address given to a client socket address
• fix graceful shutdown. make sure QUIT and TERMS signals are switched everywhere.
• :issue:799: fix support loading config from module
• :issue:805: fix check for file-like objects
• fix :issue:815: args validation in WSGIApplication.init
• fix :issue:787: check if we load a pyc file or not.

Tornado worker
++++++++++++++

• fix :issue:771: support tornado 4.0
• fix :issue:783: x_headers error. The x-forwarded-headers option has been removed
  in c4873681299212d6082cd9902740eef18c2f14f1 <https://github.com/benoitc/gunicorn/commit/c4873681299212d6082cd9902740eef18c2f14f1>_.
  The discussion is available on :pr:633.

AioHttp worker
++++++++++++++

• fix: fetch all body in input. fix :issue:803
• fix: don't install the worker if python < 3.3
• fix :issue:822: Support UNIX sockets in gaiohttp worker

Async worker
++++++++++++

• fix :issue:790: StopIteration shouldn't be catched at this level.

Logging
+++++++

• add statsd logging handler fix :issue:748

Paster
++++++

• fix :issue:809: Set global logging configuration from a Paste config.

Extra
+++++

• fix RuntimeError in gunicorn.reloader (:issue:807)

Documentation
+++++++++++++

• update faq: put a note on how watch logs in the console <http://docs.gunicorn.org/en/latest/faq.htmlwhy-i-don-t-see-any-logs-in-the-console>_
  since many people asked for it.

19.0

version improve a lot the usage of Gunicorn with python 3 by adding two new workers <http://docs.gunicorn.org/en/latest/design.htmlasyncio-workers>_
to it: gthread a fully threaded async worker using futures and gaiohttp a
worker using asyncio.

Breaking Changes

Switch QUIT and TERM signals
++++++++++++++++++++++++++++

With this change, when gunicorn receives a QUIT all the workers are
killed immediately and exit and TERM is used for the graceful shutdown.

Note: the old behaviour was based on the NGINX but the new one is more
correct according the following doc:

https://www.gnu.org/software/libc/manual/html_node/Termination-Signals.html

also it is complying with the way the signals are sent by heroku:

https://devcenter.heroku.com/articles/python-faqwhat-constraints-exist-when-developing-applications-on-heroku

Deprecations
++++++++++++

run_gunicorn, gunicorn_django and gunicorn_paster are now
completely deprecated and will be removed in the next release. Use the
gunicorn command instead.

Changes

core
++++

• add aiohttp worker named gaiohttp using asyncio. Full async worker
  on python 3.
• fix HTTP-violating excess whitespace in write_error output
• fix: try to log what happened in the worker after a timeout, add a
  worker_abort hook on SIGABRT signal.
• fix: save listener socket name in workers so we can handle buffered
  keep-alive requests after the listener has closed.
• add on_exit hook called just before exiting gunicorn.
• add support for python 3.4
• fix: do not swallow unexpected errors when reaping
• fix: remove incompatible SSL option with python 2.6
• add new async gthread worker and --threads options allows to set multiple
  threads to listen on connection
• deprecate gunicorn_django and gunicorn_paster
• switch QUIT and TERM signal
• reap workers in SIGCHLD handler
• add universal wheel support
• use email.utils.formatdate in gunicorn.util.http_date
• deprecate the --debug option
• fix: log exceptions that occur after response start …
• allows loading of applications from .pyc files (693)
• fix: issue 691, raw_env config file parsing
• use a dynamic timeout to wait for the optimal time. (Reduce power
  usage)
• fix python3 support when notifying the arbiter
• add: honor $WEB_CONCURRENCY environment variable. Useful for heroku
  setups.
• add: include tz offset in access log
• add: include access logs in the syslog handler.
• add --reload option for code reloading
• add the capability to load gunicorn.base.Application without the loading of
  the arguments of the command line. It allows you to :ref:embed gunicorn in your own application <custom>.
• improve: set wsgi.multithread to True for async workers
• fix logging: make sure to redirect wsgi.errors when needed
• add: syslog logging can now be done to a unix socket
• fix logging: don't try to redirect stdout/stderr to the logfile.
• fix logging: don't propagate log
• improve logging: file option can be overriden by the gunicorn options
  --error-logfile and --access-logfile if they are given.
• fix: don't override SERVER_* by the Host header
• fix: handle_error
• add more option to configure SSL
• fix: sendfile with SSL
• add: worker_int callback (to react on SIGTERM)
• fix: don't depend on entry point for internal classes, now absolute
  modules path can be given.
• fix: Error messages are now encoded in latin1
• fix: request line length check
• improvement: proxy_allow_ips: Allow proxy protocol if "*" specified
• fix: run worker's setup method before setting num_workers
• fix: FileWrapper inherit from object now
• fix: Error messages are now encoded in latin1
• fix: don't spam the console on SIGWINCH.
• fix: logging -don't stringify T and D logging atoms (621)
• add support for the latest django version
• deprecate run_gunicorn django option
• fix: sys imported twice

gevent worker
+++++++++++++

• fix: make sure to stop all listeners
• fix: monkey patching is now done in the worker
• fix: "global name 'hub' is not defined"
• fix: reinit hub on old versions of gevent
• support gevent 1.0
• fix: add subprocess in monkey patching
• fix: add support for multiple listener

eventlet worker
+++++++++++++++

• fix: merge duplicate EventletWorker.init_process method (fixes 657)
• fix: missing errno import for eventlet sendfile patch
• fix: add support for multiple listener

tornado worker
++++++++++++++

• add graceful stop support

================
Changelog - 2015

.. note::

Please see :doc:news for the latest changes.

18.0

---

• new: add -e/--env command line argument to pass an environment variables to
  gunicorn
• new: add --chdir command line argument to specified directory
  before apps loading. - new: add wsgi.file_wrapper support in async workers
• new: add --paste command line argument to set the paster config file
• deprecated: the command gunicorn_django is now deprecated. You should now
  run your application with the WSGI interface installed with your project (see
  https://docs.djangoproject.com/en/1.4/howto/deployment/wsgi/gunicorn/) for
  more infos.
• deprecated: the command gunicorn_paste is deprecated. You now should use
  the new --paste argument to set the configuration file of your paster
  application.
• fix: Removes unmatched leading quote from the beginning of the default access
  log format string
• fix: null timeout
• fix: gevent worker
• fix: don't reload the paster app when using pserve
• fix: after closing for error do not keep alive the connection
• fix: responses 1xx, 204 and 304 should not force the connection to be closed

17.5

---

• new: add signals documentation
• new: add post_worker_init hook for workers
• new: try to use gunicorn.conf.py in current folder as the default
  config file.
• fix graceful timeout with the Eventlet worker
• fix: don't raise an error when closing the socket if already closed
• fix: fix --settings parameter for django application and try to find
  the django settings when using the gunicorn command.
• fix: give the initial global_conf to paster application
• fix: fix 'Expect: 100-continue' support on Python 3

New versionning:
++++++++++++++++

With this release, the versionning of Gunicorn is changing. Gunicorn is
stable since a long time and there is no point to release a "1.0" now.
It should have been done since a long time. 0.17 really meant it was the
17th stable version. From the beginning we have only 2 kind of
releases:

major release: releases with major changes or huge features added
services releases: fixes and minor features added So from now we will
apply the following versionning <major>.<service>. For example 17.5 is a
service release.

0.17.4

---

• fix unix socket address parsing

0.17.3

---

• add systemd sockets support
• add python -m gunicorn.app.wsgiapp support
• improve logger class inheritance
• exit when the config file isn't found
• add the -R option to enable stdio inheritance in daemon mode
• don't close file descriptors > 3 in daemon mode
• improve STDOUT/STDERR logging
• fix pythonpath option
• fix pidfile creation on Python 3
• fix gevent worker exit
• fix ipv6 detection when the platform isn't supporting it

0.17.2

---

• optimize readline
• make imports errors more visible when loading an app or a logging
  class
• fix tornado worker: don't pass ssl options if there are none
• fix PEP3333: accept only bytetrings in the response body
• fix support on CYGWIN platforms

0.17.1

---

• add syslog facility name setting
• fix --version command line argument
• fix wsgi url_scheme for https

================
Changelog - 2014

.. note::

Please see :doc:news for the latest changes.

0.17.0

---

• allows gunicorn to bind to multiple address
• add SSL support
• add syslog support
• add nworkers_changed hook
• add response arg for post_request hook
• parse command line with argparse (replace deprecated optparse)
• fix PWD detection in arbiter
• miscellaneous PEP8 fixes

0.16.1

---

• Fix packaging

0.16.0

---

• Added support for Python 3.2 & 3.3
• Expose --pythonpath command to all gunicorn commands
• Honor $PORT environment variable, useful for deployment on heroku
• Removed support for Python 2.5
• Make sure we reopen the logs on the console
• Fix django settings module detection from path
• Reverted timeout for client socket. Fix issue on blocking issues.
• Fixed gevent worker

0.15.0

---

• new documentation site on http://docs.gunicorn.org
• new website on http://gunicorn.org
• add haproxy PROXY protocol <http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt>_ support
• add ForwardedAllowIPS option: allows to filter Front-end's IPs
  allowed to handle X-Forwarded-* headers.
• add callable hooks for paster config
• add x-forwarded-proto as secure scheme default (Heroku is using this)
• allows gunicorn to load a pre-compiled application
• support file reopening & reexec for all loggers
• initialize the logging config file with defaults.
• set timeout for client socket (slow client DoS).
• NoMoreData, ChunkMissingTerminator, InvalidChunkSize are now
  IOError exceptions
• fix graceful shutdown in gevent
• fix limit request line check

0.14.6

---

• fix gevent & subproces
• fix request line length check
• fix keepalive = 0
• fix tornado worker

0.14.5

---

• fix logging during daemonisation

0.14.4

---

• new --graceful-timeout option
• fix multiple issues with request limit
• more fixes in django settings resolutions
• fix gevent.core import
• fix keepalive=0 in eventlet worker
• fix handle_error display with the unix worker
• fix tornado.wsgi.WSGIApplication calling error

• breaking change: take the control on graceful reload back.
  graceful can't be overrided anymore using the on_reload function.

0.14.3

---

• improvement: performance of http.body.Body.readline()
• improvement: log HTTP errors in access log like Apache
• improvement: display traceback when the worker fails to boot
• improvement: makes gunicorn work with gevent 1.0
• examples: websocket example now supports hybi13
• fix: reopen log files after initialization
• fix: websockets support
• fix: django1.4 support
• fix: only load the paster application 1 time

0.14.2

---

• add validate_class validator: allows to use a class or a method to
  initialize the app during in-code configuration
• add support for max_requests in tornado worker
• add support for disabling x_forwarded_for_header in tornado worker
• gevent_wsgi is now an alias of gevent_pywsgi
• Fix gevent_pywsgi worker

0.14.1

---

• fixing source archive, reducing its size

0.14.0

---

• check if Request line is too large: You can now pass the parameter
  --limit-request-line or set the limit_request_line in your
  configuration file to set the max size of the request line in bytes.
• limit the number of headers fields and their size. Add
  --limit-request-field and limit-request-field-size settings
• add p variable to the log access format to log pidfile
• add {HeaderName}o variable to the logo access format to log the
  response header HeaderName
• request header is now logged with the variable {HeaderName}i in the
  access log file
• improve error logging
• support logging.configFile
• support django 1.4 in both gunicorn_django & run_gunicorn command
• improve reload in django run_gunicorn command (should just work now)
• allows people to set the X-Forwarded-For header key and disable it by
  setting an empty string.
• fix support of Tornado
• many other fixes.

Changelog - 2013

0.13.4

---

• fix util.closerange function used to prevent leaking fds on python 2.5
  (typo)

0.13.3

---

• refactor gevent worker
• prevent leaking fds on reexec
• fix inverted request_time computation

0.13.2

---

• Add support for Tornado 2.0 in tornado worker
• Improve access logs: allows customisation of the log format & add
  request time
• Logger module is now pluggable
• Improve graceful shutdown in Python versions >= 2.6
• Fix post_request root arity for compatibility
• Fix sendfile support
• Fix Django reloading

0.13.1

---

• Fix unix socket. log argument was missing.

0.13.0

---

• Improve logging: allows file-reopening and add access log file
  compatible with the apache combined log format <http://httpd.apache.org/docs/2.0/logs.htmlcombined>_
• Add the possibility to set custom SSL headers. X-Forwarded-Protocol
  and X-Forwarded-SSL are still the default
• New on_reload hook to customize how gunicorn spawn new workers on
  SIGHUP
• Handle projects with relative path in django_gunicorn command
• Preserve path parameters in PATH_INFO
• post_request hook now accepts the environ as argument.
• When stopping the arbiter, close the listener asap.
• Fix Django command run_gunicorn in settings reloading
• Fix Tornado_ worker exiting
• Fix the use of sendfile in wsgi.file_wrapper

0.12.2

---

• Add wsgi.file_wrapper optimised for FreeBSD, Linux & MacOSX (use
  sendfile if available)
• Fix django run_gunicorn command. Make sure we reload the application
  code.
• Fix django localisation
• Compatible with gevent 0.14dev

0.12.1

---

• Add "on_starting" hook. This hook can be used to set anything before
  the arbiter really start
• Support bdist_rpm in setup
• Improve content-length handling (pep 3333)
• Improve Django support
• Fix daemonizing (142)
• Fix ipv6 handling

.. _Tornado: http://www.tornadoweb.org/

Changelog - 2012

0.12.0

---

• Add support for logging configuration using a ini file.
  It uses the standard Python logging's module Configuration
  file format and allows anyone to use his custom file handler
• Add IPV6 support
• Add multidomain application example
• Improve gunicorn_django command when importing settings module
  using DJANGO_SETTINGS_MODULE environment variable
• Send appropriate error status on http parsing
• Fix pidfile, set permissions so other user can read
  it and use it.
• Fix temporary file leaking
• Fix setpgrp issue, can now be launched via ubuntu upstart
• Set the number of workers to zero on WINCH

0.11.2

---

• Add SERVER_SOFTWARE to the os.environ
• Add support for django settings environment variable
• Add support for logging configuration in Paster ini-files
• Improve arbiter notification in asynchronous workers
• Display the right error when a worker can't be used
• Fix Django support
• Fix HUP with Paster applications
• Fix readline in wsgi.input

0.11.1

---

• Implement max-requests feature to prevent memory leaks.
• Added 'worker_exit' server hook.
• Reseed the random number generator after fork().
• Improve Eventlet worker.
• Fix Django command run_gunicorn.
• Fix the default proc name internal setting.
• Workaround to prevent Gevent worker to segfault on MacOSX.

0.11.0

---

• Improve dramatically performances of Gevent and Eventlet workers
• Optimize HTTP parsing
• Drop Server and Date headers in start_response when provided.
• Fix latency issue in async workers

0.10.1

---

• Improve gevent's workers. Add "egg:gunicorngevent_wsgi" worker using
  gevent.wsgi <http://www.gevent.org/gevent.wsgi.html>_ and
  "egg:gunicorngevent_pywsgi" worker using gevent.pywsgi <http://www.gevent.org/gevent.pywsgi.html>_ .
  "egg:gunicorngevent" using our own HTTP parser is still here and
  is recommended for normal uses. Use the "gevent.wsgi" parser if you
  need really fast connections and don't need streaming, keepalive or ssl.
• Add pre/post request hooks
• Exit more quietly
• Fix gevent dns issue

0.10.0

---

• New HTTP parser.
• New HUP behaviour. Re-reads the configuration and then reloads all
  worker processes without changing the master process id. Helpful for
  code reloading and monitoring applications like supervisord and runit.
• Added a preload configuration parameter. By default, application code
  is now loaded after a worker forks. This couple with the new HUP
  handling can be used for dev servers to do hot code reloading. Using
  the preload flag can help a bit in small memory VM's.
• Allow people to pass command line arguments to WSGI applications. See:
  examples/alt_spec.py <http://github.com/benoitc/gunicorn/raw/master/examples/alt_spec.py>_
• Added an example gevent reloader configuration:
  examples/example_gevent_reloader.py <http://github.com/benoitc/gunicorn/blob/master/examples/example_gevent_reloader.py>_.
• New gevent worker "egg:gunicorngevent2", working with gevent.wsgi.
• Internal refactoring and various bug fixes.
• New documentation website.

0.9.1

---

• Support https via X-Forwarded-Protocol or X-Forwarded-Ssl headers
• Fix configuration
• Remove -d options which was used instead of -D for daemon.
• Fix umask in unix socket

0.9.0

---

• Added when_ready hook. Called just after the server is started
• Added preload setting. Load application code before the worker processes
  are forked.
• Refactored Config
• Fix pidfile
• Fix QUIT/HUP in async workers
• Fix reexec
• Documentation improvements

0.8.1

---

• Fix builtins import in config
• Fix installation with pip
• Fix Tornado WSGI support
• Delay application loading until after processing all configuration

0.8.0

---

• Refactored Worker management for better async support. Now use the -k option
  to set the type of request processing to use
• Added support for Tornado_

0.7.2

---

• Added --spew option to help debugging (installs a system trace hook)
• Some fixes in async arbiters
• Fix a bug in start_response on error

0.7.1

---

• Fix bug when responses have no body.

0.7.0

---

• Added support for Eventlet_ and Gevent_ based workers.
• Added Websockets_ support
• Fix Chunked Encoding
• Fix SIGWINCH on OpenBSD_
• Fix PEP 333_ compliance for the write callable.

0.6.5

---

• Fix pidfile handling
• Fix Exception Error

0.6.4

---

• Use cStringIO for performance when possible.
• Fix worker freeze when a remote connection closes unexpectedly.

0.6.3

---

• Make HTTP parsing faster.
• Various bug fixes

0.6.2

---

• Added support for chunked response.
• Added proc_name option to the config file.
• Improved the HTTP parser. It now uses buffers instead of strings to store
  temporary data.
• Improved performance when sending responses.
• Workers are now murdered by age (the oldest is killed first).

0.6.1

---

• Added gunicorn config file support for Django admin command
• Fix gunicorn config file. -c was broken.
• Removed TTIN/TTOU from workers which blocked other signals.

0.6.0

---

• Added setproctitle support
• Change privilege switch behavior. We now work like NGINX, master keeps the
  permissions, new uid/gid permissions are only set for workers.

0.5.1

---

• Fix umask
• Added Debian packaging

0.5.0

---

• Added configuration file <configuration.html>_ handler.
• Added support for pre/post fork hooks
• Added support for before_exec hook
• Added support for unix sockets
• Added launch of workers processes under different user/group
• Added umask option
• Added SCRIPT_NAME support
• Better support of some exotic settings for Django projects
• Better support of Paste-compatible applications
• Some refactoring to make the code easier to hack
• Allow multiple keys in request and response headers

.. _Tornado: http://www.tornadoweb.org/
.. _PEP 333: http://www.python.org/dev/peps/pep-0333/
.. _Eventlet: http://eventlet.net
.. _Gevent: http://gevent.org
.. _OpenBSD: http://openbsd.org
.. _Websockets: http://dev.w3.org/html5/websockets/

Changelog - 2011

Sphinx -> 1.6.4

1.6.4

=====================================

Features added

• 3926: Add autodoc_warningiserror to suppress the behavior of -W
  option during importing target modules on autodoc

Bugs fixed

• 3924: docname lost after dynamically parsing RST in extension
• 3946: Typo in sphinx.sty (this was a bug with no effect in default context)
• :pep: and :rfc: does not supports default-role directive (refs: 3960)
• 3960: default_role = 'guilabel' not functioning
• Missing texinputs_win/Makefile to be used in latexpdf builder on windows.
• 4026: nature: Fix macOS Safari scrollbar color
• 3877: Fix for C++ multiline signatures.
• 4006: Fix crash on parallel build
• 3969: private instance attributes causes AttributeError
• 4041: C++, remove extra name linking in function pointers.
• 4038: C, add missing documentation of member role.
• 4044: An empty multicolumn cell causes extra row height in PDF output
• 4049: Fix typo in output of sphinx-build -h
• 4062: hashlib.sha1() must take bytes, not unicode on Python 3
• Avoid indent after index entries in latex (refs: 4066)
• 4070: crashes when the warning message contains format strings
• 4067: Return non-zero exit status when make subprocess fails
• 4055: graphviz: the :align: option does not work for SVG output
• 4055: graphviz: the :align: center option does not work for latex output
• 4051: warn() function for HTML theme outputs 'None' string

1.6.3

=====================================

Features added

• latex: hint that code-block continues on next page (refs: 3764, 3792)

Bugs fixed

• 3821: Failed to import sphinx.util.compat with docutils-0.14rc1
• 3829: sphinx-quickstart template is incomplete regarding use of alabaster
• 3772: 'str object' has no attribute 'filename'
• Emit wrong warnings if citation label includes hyphens (refs: 3565)
• 3858: Some warnings are not colored when using --color option
• 3775: Remove unwanted whitespace in default template
• 3835: sphinx.ext.imgmath fails to convert SVG images if project directory
  name contains spaces
• 3850: Fix color handling in make mode's help command
• 3865: use of self.env.warn in sphinx extension fails
• 3824: production lists apply smart quotes transform since Sphinx 1.6.1
• latex: fix \sphinxbfcode swallows initial space of argument
• 3878: Quotes in auto-documented class attributes should be straight quotes
  in PDF output
• 3881: LaTeX figure floated to next page sometimes leaves extra vertical
  whitespace
• 3885: duplicated footnotes raises IndexError
• 3873: Failure of deprecation warning mechanism of
  sphinx.util.compat.Directive
• 3874: Bogus warnings for "citation not referenced" for cross-file citations
• 3860: Don't download images when builders not supported images
• 3860: Remote image URIs without filename break builders not supported remote
  images
• 3833: command line messages are translated unintentionally with language
  setting.
• 3840: make checking epub_uid strict
• 3851, 3706: Fix about box drawing characters for PDF output
• 3900: autosummary could not find methods
• 3902: Emit error if latex_documents contains non-unicode string in py2

1.6.2

=====================================

Incompatible changes

• 3789: Do not require typing module for python>=3.5

Bugs fixed

• 3754: HTML builder crashes if HTML theme appends own stylesheets
• 3756: epub: Entity 'mdash' not defined
• 3758: Sphinx crashed if logs are emitted in conf.py
• 3755: incorrectly warns about dedent with literalinclude
• 3742: RTD <https://readthedocs.org/>_ PDF builds of Sphinx own docs are
  missing an index entry in the bookmarks and table of contents. This is
  rtfd/readthedocs.org2857 <https://github.com/rtfd/readthedocs.org/issues/2857>_ issue, a workaround
  is obtained using some extra LaTeX code in Sphinx's own :file:conf.py
• 3770: Build fails when a "code-block" has the option emphasize-lines and the
  number indicated is higher than the number of lines
• 3774: Incremental HTML building broken when using citations
• 3763: got epubcheck validations error if epub_cover is set
• 3779: 'ImportError' in sphinx.ext.autodoc due to broken 'sys.meta_path'.
  Thanks to Tatiana Tereshchenko.
• 3796: env.resolve_references() crashes when non-document node given
• 3803: Sphinx crashes with invalid PO files
• 3791: PDF "continued on next page" for long tables isn't internationalized
• 3788: smartquotes emits warnings for unsupported languages
• 3807: latex Makefile for make latexpdf is only for unixen
• 3781: double hyphens in option directive are compiled as endashes
• 3817: latex builder raises AttributeError

1.6.1

=====================================

Dependencies

1.6

• LDML format support in i18n feature
• sphinx.addnodes.termsep
• Some functions and classes in sphinx.util.pycompat:
  zip_longest, product, all, any, next, open,
  class_types, base_exception, relpath, StringIO, BytesIO.
  Please use the standard library version instead;

If any deprecation warning like RemovedInSphinxXXXWarning are displayed,
please refer :ref:when-deprecation-warnings-are-displayed.

Features added

1.6b3

• 3588: No compact (p tag) html output in the i18n document build even when
  :confval:html_compact_lists is True.
• The make latexpdf from 1.6b1 (for GNU/Linux and Mac OS, using
  latexmk) aborted earlier in case of LaTeX errors than was the case with
  1.5 series, due to hard-coded usage of --halt-on-error option. (refs 3695)
• 3683: sphinx.websupport module is not provided by default
• 3683: Failed to build document if builder.css_file.insert() is called
• 3714: viewcode extension not taking highlight_code='none' in account
• 3698: Moving :doc: to std domain broke backwards compatibility
• 3633: misdetect unreferenced citations

1.6b2

• 3662: builder.css_files is deprecated. Please use add_stylesheet()
  API instead.

1.6b1

• sphinx.util.compat.Directive class is now deprecated. Please use instead
  docutils.parsers.rst.Directive
• sphinx.util.compat.docutils_version is now deprecated
• 2367: Sphinx.warn(), Sphinx.info() and other logging methods are now
  deprecated. Please use sphinx.util.logging (:ref:logging-api) instead.
• 3318: notice is now deprecated as LaTeX environment name and will be
  removed at Sphinx 1.7. Extension authors please use sphinxadmonition
  instead (as Sphinx does since 1.5.)
• Sphinx.status_iterator() and Sphinx.old_status_iterator() is now
  deprecated. Please use sphinx.util:status_iterator() instead.
• Sphinx._directive_helper() is deprecated. Please use
  sphinx.util.docutils.directive_helper() instead.
• BuildEnvironment.set_warnfunc() is now deprecated
• Following methods of BuildEnvironment is now deprecated.

• BuildEnvironment.note_toctree()
• BuildEnvironment.get_toc_for()
• BuildEnvironment.get_toctree_for()
• BuildEnvironment.create_index()

Please use sphinx.environment.adapters modules instead.

• latex package footnote is not loaded anymore by its bundled replacement
  footnotehyper-sphinx. The redefined macros keep the same names as in the
  original package.
• 3429: deprecate config setting latex_keep_old_macro_names. It will be
  removed at 1.7, and already its default value has changed from True to
  False.
• 3221: epub2 builder is deprecated
• 3254: sphinx.websupport is now separated into independent package;
  sphinxcontrib-websupport. sphinx.websupport will be removed in
  Sphinx-2.0.
• 3628: sphinx_themes entry_point is deprecated. Please use
  sphinx.html_themes instead.

1.5.6

=====================================

Bugs fixed

• 3614: Sphinx crashes with requests-2.5.0
• 3618: autodoc crashes with tupled arguments
• 3664: No space after the bullet in items of a latex list produced by Sphinx
• 3657: EPUB builder crashes if document startswith genindex exists
• 3588: No compact (p tag) html output in the i18n document build even when
  :confval:html_compact_lists is True.
• 3685: AttributeError when using 3rd party domains
• 3702: LaTeX writer styles figure legends with a hard-coded \small
• 3708: LaTeX writer allows irc scheme
• 3717: Stop enforcing that favicon's must be .ico
• 3731, 3732: Protect isenumclass predicate against non-class arguments
• 3320: Warning about reference target not being found for container types
• Misspelled ARCHIVEPREFIX in Makefile for latex build repertory

1.5.5

=====================================

Bugs fixed

• 3597: python domain raises UnboundLocalError if invalid name given
• 3599: Move to new Mathjax CDN

1.5.4

=====================================

Features added

• 3470: Make genindex support all kinds of letters, not only Latin ones

Bugs fixed

• 3445: setting 'inputenc' key to \\usepackage[utf8x]{inputenc} leads
  to failed PDF build
• EPUB file has duplicated nav.xhtml link in content.opf
  except first time build
• 3488: objects.inv has broken when release or version contain
  return code
• 2073, 3443, 3490: gettext builder that writes pot files unless the content
  are same without creation date. Thanks to Yoshiki Shibukawa.
• 3487: intersphinx: failed to refer options
• 3496: latex longtable's last column may be much wider than its contents
• 3507: wrong quotes in latex output for productionlist directive
• 3533: Moving from Sphinx 1.3.1 to 1.5.3 breaks LaTeX compilation of links
  rendered as code
• 2665, 2607: Link names in C++ docfields, and make it possible for other domains.
• 3542: C++, fix parsing error of non-type template argument with template.
• 3065, 3520: python domain fails to recognize nested class
• 3575: Problems with pdflatex in a Turkish document built with sphinx has
  reappeared (refs 2997, 2397)
• 3577: Fix intersphinx debug tool
• A LaTeX command such as \\large inserted in the title items of
  :confval:latex_documents causes failed PDF build (refs 3551, 3567)

1.5.3

=====================================

Features added

• Support requests-2.0.0 (experimental) (refs: 3367)
• (latex) PDF page margin dimensions may be customized (refs: 3387)
• literalinclude directive allows combination of :pyobject: and
  :lines: options (refs: 3416)
• 3400: make-mode doesn't use subprocess on building docs

Bugs fixed

• 3370: the caption of code-block is not picked up for translation
• LaTeX: :confval:release is not escaped (refs: 3362)
• 3364: sphinx-quickstart prompts overflow on Console with 80 chars width
• since 1.5, PDF's TOC and bookmarks lack an entry for general Index
  (refs: 3383)
• 3392: 'releasename' in :confval:latex_elements is not working
• 3356: Page layout for Japanese 'manual' docclass has a shorter text area
• 3394: When 'pointsize' is not 10pt, Japanese 'manual' document
  gets wrong PDF page dimensions
• 3399: quickstart: conf.py was not overwritten by template
• 3366: option directive does not allow punctuations
• 3410: return code in :confval:release breaks html search
• 3427: autodoc: memory addresses are not stripped on Windows
• 3428: xetex build tests fail due to fontspec v2.6 defining \strong
• 3349: Result of IndexBuilder.load() is broken
• 3450: &nbsp is appeared in EPUB docs
• 3418: Search button is misaligned in nature and pyramid theme
• 3421: Could not translate a caption of tables
• 3552: linkcheck raises UnboundLocalError

1.5.2

=====================================

Incompatible changes

• Dependency requirement updates: requests 2.4.0 or above (refs: 3268, 3310)

Features added

• 3241: emit latex warning if buggy titlesec (ref 3210)
• 3194: Refer the $MAKE environment variable to determine make command
• Emit warning for nested numbered toctrees (refs: 3142)
• 978: intersphinx_mapping also allows a list as a parameter
• 3340: (LaTeX) long lines in :dudir:parsed-literal are wrapped like in
  :rst:dir:code-block, inline math and footnotes are fully functional.

Bugs fixed

• 3246: xapian search adapter crashes
• 3253: In Py2 environment, building another locale with a non-captioned
  toctree produces None captions
• 185: References to section title including raw node has broken
• 3255: In Py3.4 environment, autodoc doesn't support documentation for
  attributes of Enum class correctly.
• 3261: latex_use_parts makes sphinx crash
• The warning type misc.highlighting_failure does not work
• 3294: add_latex_package() make crashes non-LaTeX builders
• The caption of table are rendered as invalid HTML (refs: 3287)
• 3268: Sphinx crashes with requests package from Debian jessie
• 3284: Sphinx crashes on parallel build with an extension which raises
  unserializable exception
• 3315: Bibliography crashes on latex build with docclass 'memoir'
• 3328: Could not refer rubric implicitly
• 3329: emit warnings if po file is invalid and can't read it. Also writing mo too
• 3337: Ugly rendering of definition list term's classifier
• 3335: gettext does not extract field_name of a field in a field_list
• 2952: C++, fix refs to operator() functions.
• Fix Unicode super- and subscript digits in :rst:dir:code-block and
  parsed-literal LaTeX output (ref 3342)
• LaTeX writer: leave " character inside parsed-literal as is (ref 3341)
• 3234: intersphinx failed for encoded inventories
• 3158: too much space after captions in PDF output
• 3317: An URL in parsed-literal contents gets wrongly rendered in PDF if
  with hyphen
• LaTeX crash if the filename of an image inserted in parsed-literal
  via a substitution contains an hyphen (ref 3340)
• LaTeX rendering of inserted footnotes in parsed-literal is wrong (ref 3340)
• Inline math in parsed-literal is not rendered well by LaTeX (ref 3340)
• 3308: Parsed-literals don't wrap very long lines with pdf builder (ref 3340)
• 3295: Could not import extension sphinx.builders.linkcheck
• 3285: autosummary: asterisks are escaped twice
• LaTeX, pass dvipdfm option to geometry package for Japanese documents (ref 3363)
• Fix parselinenos() could not parse left half open range (cf. "-4")

1.5.1

=====================================

Features added

• 3214: Allow to suppress "unknown mimetype" warnings from epub builder using
  :confval:suppress_warnings.

Bugs fixed

• 3195: Can not build in parallel
• 3198: AttributeError is raised when toctree has 'self'
• 3211: Remove untranslated sphinx locale catalogs (it was covered by
  untranslated it_IT)
• 3212: HTML Builders crashes with docutils-0.13
• 3207: more latex problems with references inside parsed-literal directive
  (\DUrole)
• 3205: sphinx.util.requests crashes with old pyOpenSSL (< 0.14)
• 3220: KeyError when having a duplicate citation
• 3200: LaTeX: xref inside desc_name not allowed
• 3228: build_sphinx command crashes when missing dependency
• 2469: Ignore updates of catalog files for gettext builder. Thanks to
  Hiroshi Ohkubo.
• 3183: Randomized jump box order in generated index page.

1.5

• 3069: Even if 'babel' key is set to empty string, LaTeX output contains
  one \addto\captions...
• 3123: user 'babel' key setting is not obeyed anymore
• 3155: Fix JavaScript for html_sourcelink_suffix fails with IE and Opera
• 3085: keep current directory after breaking build documentation. Thanks to
  Timotheus Kampik.
• 3181: pLaTeX crashes with a section contains endash
• 3180: latex: add stretch/shrink between successive singleline or
  multipleline cpp signatures (ref 3072)
• 3128: globing images does not support .svgz file
• 3015: fix a broken test on Windows.
• 1843: Fix documentation of descriptor classes that have a custom metaclass.
  Thanks to Erik Bray.
• 3190: util.split_docinfo fails to parse multi-line field bodies
• 3024, 3037: In Python3, application.Sphinx._log crushed when the log message cannot
  be encoded into console encoding.

Testing

• To simplify, sphinx uses external mock package even if unittest.mock exists.

1.5b1

• 2432: Fix unwanted * between varargs and keyword only args. Thanks to Alex Grönholm.
• 3062: Failed to build PDF using 1.5a2 (undefined \hypersetup for
  Japanese documents since PR3030)
• Better rendering of multiline signatures in html.
• 777: LaTeX output "too deeply nested" (ref 3096)
• Let LaTeX image inclusion obey scale before textwidth fit (ref 2865, 3059)
• 3019: LaTeX fails on description of C function with arguments (ref 3083)
• fix latex inline literals where < > - gobbled a space

1.5a2

• 2810: Problems with pdflatex in an Italian document
• Use latex_elements.papersize to specify papersize of LaTeX in Makefile
• 2988: linkcheck: retry with GET request if denied HEAD request
• 2990: linkcheck raises "Can't convert 'bytes' object to str implicitly" error
  if linkcheck_anchors enabled
• 3004: Invalid link types "top" and "up" are used
• 3009: Bad rendering of parsed-literals in LaTeX since Sphinx 1.4.4
• 3000: option directive generates invalid HTML anchors
• 2984: Invalid HTML has been generated if html_split_index enabled
• 2986: themes/basic/defindex.html should be changed for html5 friendly
• 2987: Invalid HTML has been generated if multiple IDs are assigned to a list
• 2891: HTML search does not provide all the results
• 1986: Title in PDF Output
• 147: Problem with latex chapter style
• 3018: LaTeX problem with page layout dimensions and chapter titles
• Fix an issue with \pysigline in LaTeX style file (ref 3023)
• 3038: sphinx.ext.math* raises TypeError if labels are duplicated
• 3031: incompatibility with LaTeX package tocloft
• 3003: literal blocks in footnotes are not supported by Latex
• 3047: spacing before footnote in pdf output is not coherent and allows breaks
• 3045: HTML search index creator should ignore "raw" content if now html
• 3039: English stemmer returns wrong word if the word is capitalized
• Fix make-mode Makefile template (ref 3056, 2936)

1.5a1

• 2707: (latex) the column width is badly computed for tabular
• 2799: Sphinx installs roles and directives automatically on importing sphinx
  module. Now Sphinx installs them on running application.
• sphinx.ext.autodoc crashes if target code imports * from mock modules
  by autodoc_mock_imports.
• 1953: Sphinx.add_node does not add handlers the translator installed by
  html_translator_class
• 1797: text builder inserts blank line on top
• 2894: quickstart main() doesn't use argv argument
• 2874: gettext builder could not extract all text under the only
  directives
• 2485: autosummary crashes with multiple source_suffix values
• 1734: Could not translate the caption of toctree directive
• Could not translate the content of meta directive (ref: 1734)
• 2550: external links are opened in help viewer
• 2687: Running Sphinx multiple times produces 'already registered' warnings

1.4.9

=====================================

Bugs fixed

• 2936: Fix doc/Makefile that can't build man because doc/man exists
• 3058: Using the same 'caption' attribute in multiple 'toctree' directives
  results in warning / error
• 3068: Allow the '=' character in the -D option of sphinx-build.py
• 3074: add_source_parser() crashes in debug mode
• 3135: sphinx.ext.autodoc crashes with plain Callable
• 3150: Fix query word splitter in JavaScript. It behaves as same as Python's regular expression.
• 3093: gettext build broken on substituted images.
• 3093: gettext build broken on image node under note directive.
• imgmath: crashes on showing error messages if image generation failed
• 3117: LaTeX writer crashes if admonition is placed before first section title
• 3164: Change search order of sphinx.ext.inheritance_diagram

1.4.8

====================================

Bugs fixed

• 2996: The wheel package of Sphinx got crash with ImportError

1.4.7

====================================

Bugs fixed

• 2890: Quickstart should return an error consistently on all error conditions
• 2870: flatten genindex columns' heights.
• 2856: Search on generated HTML site doesnt find some symbols
• 2882: Fall back to a GET request on 403 status in linkcheck
• 2902: jsdump.loads fails to load search index if keywords starts with
  underscore
• 2900: Fix epub content.opf: add auto generated orphan files to spine.
• 2899: Fix hasdoc() function in Jinja2 template. It can detect genindex, search collectly.
• 2901: Fix epub result: skip creating links from image tags to original image files.
• 2917: inline code is hyphenated on HTML
• 1462: autosummary warns for namedtuple with attribute with trailing underscore
• Could not reference equations if :nowrap: option specified
• 2873: code-block overflow in latex (due to commas)
• 1060, 2056: sphinx.ext.intersphinx: broken links are generated if relative
  paths are used in intersphinx_mapping
• 2931: code-block directive with same :caption: causes warning of duplicate
  target. Now code-block and literalinclude does not define hyperlink
  target using its caption automatially.
• 2962: latex: missing label of longtable
• 2968: autodoc: show-inheritance option breaks docstrings

1.4.6

=====================================

Incompatible changes

• 2867: linkcheck builder crashes with six-1.4. Now Sphinx depends on six-1.5 or
  later

Bugs fixed

• applehelp: Sphinx crashes if hiutil or codesign commands not found
• Fix make clean abort issue when build dir contains regular files like DS_Store.
• Reduce epubcheck warnings/errors:

• Fix DOCTYPE to html5
• Change extension from .html to .xhtml.
• Disable search page on epub results

• 2778: Fix autodoc crashes if obj.dict is a property method and raises exception
• Fix duplicated toc in epub3 output.
• 2775: Fix failing linkcheck with servers not supporting identidy encoding
• 2833: Fix formatting instance annotations in ext.autodoc.
• 1911: -D option of sphinx-build does not override the extensions variable
• 2789: sphinx.ext.intersphinx generates wrong hyperlinks if the inventory is given
• parsing errors for caption of code-blocks are displayed in document (ref: 2845)
• 2846: singlehtml builder does not include figure numbers
• 2816: Fix data from builds cluttering the Domain.initial_data class attributes

1.4.5

=====================================

Incompatible changes

• latex, inclusion of non-inline images from image directive resulted in
  non-coherent whitespaces depending on original image width; new behaviour
  by necessity differs from earlier one in some cases. (ref: 2672)
• latex, use of \includegraphics to refer to Sphinx custom variant is
  deprecated; in future it will revert to original LaTeX macro, custom one
  already has alternative name \sphinxincludegraphics.

Features added

• new config option latex_keep_old_macro_names, defaults to True. If False,
  lets macros (for text styling) be defined only with \sphinx-prefixed names.
• latex writer allows user customization of "shadowed" boxes (topics), via
  three length variables.
• woff-format web font files now supported by the epub builder.

Bugs fixed

• jsdump fix for python 3: fixes the HTML search on python > 3
• 2676: (latex) Error with verbatim text in captions since Sphinx 1.4.4
• 2629: memoir class crashes LaTeX. Fixed by latex_keep_old_macro_names=False (ref 2675)
• 2684: sphinx.ext.intersphinx crashes with six-1.4.1
• 2679: float package needed for 'figure_align': 'H' latex option
• 2671: image directive may lead to inconsistent spacing in pdf
• 2705: toctree generates empty bullet_list if :titlesonly: specified
• 2479: sphinx.ext.viewcode uses python2 highlighter by default
• 2700: HtmlHelp builder has hard coded index.html
• latex, since 1.4.4 inline literal text is followed by spurious space
• 2722: C++, fix id generation for var/member declarations to include namespaces.
• latex, images (from image directive) in lists or quoted blocks did not obey
  indentation (fixed together with 2671)
• 2733: since Sphinx-1.4.4 make latexpdf generates lots of hyperref warnings
• 2731: sphinx.ext.autodoc does not access propertymethods which raises any
  exceptions
• 2666: C++, properly look up nested names involving constructors.
• 2579: Could not refer a label including both spaces and colons via
  sphinx.ext.intersphinx
• 2718: Sphinx crashes if the document file is not readable
• 2699: hyperlinks in help HTMLs are broken if html_file_suffix is set
• 2723: extra spaces in latex pdf output from multirow cell
• 2735: latexpdf Underfull \hbox (badness 10000) warnings from title page
• 2667: latex crashes if resized images appeared in section title
• 2763: (html) Provide default value for required alt attribute for image
  tags of SVG source, required to validate and now consistent w/ other formats.

1.4.4

=====================================

Bugs fixed

• 2630: Latex sphinx.sty Notice Enviroment formatting problem
• 2632: Warning directives fail in quote environment latex build
• 2633: Sphinx crashes with old styled indices
• Fix a \begin{\minipage} typo in sphinx.sty from 1.4.2 (ref: 68becb1)
• 2622: Latex produces empty pages after title and table of contents
• 2640: 1.4.2 LaTeX crashes if code-block inside warning directive
• Let LaTeX use straight quotes also in inline code (ref 2627)
• 2351: latex crashes if enumerated lists are placed on footnotes
• 2646: latex crashes if math contains twice empty lines
• 2480: sphinx.ext.autodoc: memory addresses were shown
• latex: allow code-blocks appearing inside lists and quotes at maximal nesting
  depth (ref 777, 2624, 2651)
• 2635: Latex code directives produce inconsistent frames based on viewing
  resolution
• 2639: Sphinx now bundles iftex.sty
• Failed to build PDF with framed.sty 0.95
• Sphinx now bundles needspace.sty

1.4.3

====================================

Bugs fixed

• 2530: got "Counter too large" error on building PDF if large numbered
  footnotes existed in admonitions
• width option of figure directive does not work if align option specified at same time (ref: 2595)
• 2590: The inputenc package breaks compiling under lualatex and xelatex
• 2540: date on latex front page use different font
• Suppress "document isn't included in any toctree" warning if the document is included (ref: 2603)
• 2614: Some tables in PDF output will end up shifted if user sets non zero
  \parindent in preamble
• 2602: URL redirection breaks the hyperlinks generated by sphinx.ext.intersphinx
• 2613: Show warnings if merged extensions are loaded
• 2619: make sure amstext LaTeX package always loaded (ref: d657225, 488ee52,
  9d82cad and 2615)
• 2593: latex crashes if any figures in the table

1.4.2

===========================