[Checkins] [zopefoundation/transaction] fa8fd7: Documentation gardening.

Jason Madden noreply at github.com
Wed Dec 11 09:28:43 CET 2019


  Branch: refs/heads/master
  Home:   https://github.com/zopefoundation/transaction
  Commit: fa8fd7a1a45fb73735af50f42da7564e09ffedb6
      https://github.com/zopefoundation/transaction/commit/fa8fd7a1a45fb73735af50f42da7564e09ffedb6
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2019-12-09 (Mon, 09 Dec 2019)

  Changed paths:
    M docs/api.rst
    M docs/conf.py
    M docs/convenience.rst
    M docs/integrations.rst
    M transaction/interfaces.py

  Log Message:
  -----------
  Documentation gardening.

- conf.py: Use default autodoc flags, and prepare for Sphinx 2.0.
- conf.py: Read the correct version number for transaction.
- conf.py: Add intersphinx mappings for stdlib and ZODB.
- conf.py: Make the default role be object references, enabling
   `IThing` instead of :class:`IThing` for prettier docstrings.
- interfaces.py: Cross references.
- interfaces.py: ITransaction: Remove outdated docs about using
   a single transaction object more than one time. That doesn't
   work anymore.
- interfaces.py: Simplify copied documentation, especially for
   the various ITransaction hook methods.
- convenience.rst, integrations.rst: Fix compatibility with Sphinx 2 and straighten adornments
   Previously they raised "TypeError: '_traversal_list' object is not reversible"
   from sphinx.util.nodes line 151 apply_source_workaround.


  Commit: a47b6c7ef014a024669c7f4bb89238ef9e3f543c
      https://github.com/zopefoundation/transaction/commit/a47b6c7ef014a024669c7f4bb89238ef9e3f543c
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2019-12-11 (Wed, 11 Dec 2019)

  Changed paths:
    M docs/api.rst
    M docs/conf.py
    M docs/convenience.rst
    M docs/integrations.rst
    M transaction/interfaces.py

  Log Message:
  -----------
  Merge pull request #88 from zopefoundation/docs-take-2

Documentation gardening.


Compare: https://github.com/zopefoundation/transaction/compare/41a3e56f3a58...a47b6c7ef014


More information about the checkins mailing list