[Checkins] [zopefoundation/zope.session] f32f22: Sphinx documentation

GitHub noreply at github.com
Sat Nov 18 14:05:01 CET 2017


  Branch: refs/heads/master
  Home:   https://github.com/zopefoundation/zope.session
  Commit: f32f227556f213345993d834c8effdccb297d419
      https://github.com/zopefoundation/zope.session/commit/f32f227556f213345993d834c8effdccb297d419
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-11-17 (Fri, 17 Nov 2017)

  Changed paths:
    M .gitignore
    M .travis.yml
    M CHANGES.rst
    M MANIFEST.in
    M README.rst
    A doc-requirements.txt
    A docs/api.rst
    A docs/changelog.rst
    A docs/conf.py
    A docs/design.rst
    A docs/http.rst
    A docs/index.rst
    A docs/interfaces.rst
    A docs/session.rst
    M setup.py
    R src/zope/session/api.rst
    R src/zope/session/design.rst
    M src/zope/session/http.py
    M src/zope/session/interfaces.py
    M src/zope/session/session.py
    M src/zope/session/tests.py
    M tox.ini

  Log Message:
  -----------
  Sphinx documentation

- Move api.rst and design.rst to the docs/ folder and let sphinx run
  those doctests.
- Expose the API documentation for interfaces.py; this required a
  change to one of its docstrings to not look like a doctest; it
  wasn't being run as one previously.
- Expose http.py and session.py API docs. This required some very
  minor changes to a doctest to pass under Sphinx due to loss of the
  normalizer. I also took the opportunity to change uses of
  empty io.StringIO into the more semantically correct io.BytesIO in
  doctests.

Fixes #7


  Commit: 4a22c32245cba83c4be9d5a62a5ccce0d3af1b23
      https://github.com/zopefoundation/zope.session/commit/4a22c32245cba83c4be9d5a62a5ccce0d3af1b23
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-11-17 (Fri, 17 Nov 2017)

  Changed paths:
    M docs/api.rst
    M src/zope/session/session.py
    M src/zope/session/tests.py

  Log Message:
  -----------
  Simplify and localize the test fixtures in order to get back to 100% coverage.

This also makes the documentation more explicit about what's required.


  Commit: 5d86339b39b158fedf5aab990374f7590c9925b8
      https://github.com/zopefoundation/zope.session/commit/5d86339b39b158fedf5aab990374f7590c9925b8
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-11-17 (Fri, 17 Nov 2017)

  Changed paths:
    M docs/api.rst
    M setup.py
    M src/zope/session/adapters.zcml
    M src/zope/session/classes.zcml

  Log Message:
  -----------
  Test the configure.zcml in api.rst

And document using it. This reduces boilerplate and adds clarity. One
of the statements on the documentation ("the unnamed
ISessionDataContainer is created automatically") was wrong and was
removed.


  Commit: 425951437d8d77ac4a29b42e94e7faf2333a9b5a
      https://github.com/zopefoundation/zope.session/commit/425951437d8d77ac4a29b42e94e7faf2333a9b5a
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-11-17 (Fri, 17 Nov 2017)

  Changed paths:
    M src/zope/session/tests.py

  Log Message:
  -----------
  Stop leaking open files that produce ResourceWarning on Python 3


  Commit: bdf4e7330229f5d80c7c74a53b9ca5aecb8702a7
      https://github.com/zopefoundation/zope.session/commit/bdf4e7330229f5d80c7c74a53b9ca5aecb8702a7
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-11-18 (Sat, 18 Nov 2017)

  Changed paths:
    M docs/api.rst
    M docs/conf.py
    M docs/design.rst
    M src/zope/session/http.py
    M src/zope/session/interfaces.py
    M src/zope/session/session.py

  Log Message:
  -----------
  Adjustments per review of #9


  Commit: 2c8d3607cfe9ef727e1de07aa3a428f958a4535e
      https://github.com/zopefoundation/zope.session/commit/2c8d3607cfe9ef727e1de07aa3a428f958a4535e
  Author: Jason Madden <jason+github at nextthought.com>
  Date:   2017-11-18 (Sat, 18 Nov 2017)

  Changed paths:
    M .gitignore
    M .travis.yml
    M CHANGES.rst
    M MANIFEST.in
    M README.rst
    A doc-requirements.txt
    A docs/api.rst
    A docs/changelog.rst
    A docs/conf.py
    A docs/design.rst
    A docs/http.rst
    A docs/index.rst
    A docs/interfaces.rst
    A docs/session.rst
    M setup.py
    M src/zope/session/adapters.zcml
    R src/zope/session/api.rst
    M src/zope/session/classes.zcml
    R src/zope/session/design.rst
    M src/zope/session/http.py
    M src/zope/session/interfaces.py
    M src/zope/session/session.py
    M src/zope/session/tests.py
    M tox.ini

  Log Message:
  -----------
  Merge pull request #9 from zopefoundation/docs

Sphinx documentation


Compare: https://github.com/zopefoundation/zope.session/compare/12d01abdaf85...2c8d3607cfe9


More information about the checkins mailing list