[Checkins] [zopefoundation/zope.session] f32f22: Sphinx documentation
GitHub
noreply at github.com
Fri Nov 17 15:27:07 CET 2017
Branch: refs/heads/docs
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
More information about the checkins
mailing list