Skip to content

Commit

Permalink
Overhaul docs.
Browse files Browse the repository at this point in the history
- Document backporting
- Reference the cPython dev docs for everything else.
- Test docs and package summary.
  • Loading branch information
rbtcollins committed Jul 10, 2015
1 parent 6f72979 commit 18c9bbd
Show file tree
Hide file tree
Showing 18 changed files with 233 additions and 5,684 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ runtox
.*.swp
AUTHORS
ChangeLog
.eggs
README.saved
README.html
16 changes: 11 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,19 @@ python:
- "3.2"
- "3.3"
- "3.4"
- "nightly"
- pypy
- pypy3
# command to install dependencies
matrix:
include:
# Travis nightly look to be 3.5.0a4, b3 is out and the syntax error we see
# doesn't happen in trunk.
- python: "nightly"
env: SKIP_DOCS=1
install:
- pip install -U pip
- pip install -U wheel setuptools
- pip install .[test]
# command to run tests
script: unit2
- pip install -U .[docs,test]
script:
- unit2
- if [ -z "$SKIP_DOCS" ]; then python setup.py build_sphinx; fi
- rst2html.py README.txt README.html
2 changes: 1 addition & 1 deletion NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- Issue #23581: Add matmul support to MagicMock. Patch by Håkan Lövdahl.

- Issue #23326: Removed __ne__ implementations. Since fixing default __ne__
implementation in issue #21408 they are redundant. **** NOT BACKPORTED ****
implementation in issue #21408 they are redundant. *** NOT BACKPORTED ***

- Issue #21270: We now override tuple methods in mock.call objects so that
they can be used as normal call attributes.
Expand Down
45 changes: 16 additions & 29 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,32 +11,19 @@ compatible with Python 2.7 and up, and 3.2 and up.

Please see the standard library documentation for more details.

mock is CI tested using Travis-CI on Python versions 2.7, 3.2, 3.3, 3.4, 3.5,
nightly Python 3 builds, pypy, pypy3. Jython support is desired, if
someone could contribute a patch to .travis.jml to support it that would be
excellent.

The last release of mock to support 2.6 was 1.0.1. mock 1.1.0 and above require
Python 2.7 or higher.

NEWS entries from cPython:

.. include:: NEWS

Notes for maintainers
---------------------

Releasing
=========

2. tag -s, push --tags origin master
3. setup.py sdist bdist_wheel upload -s

Backporting rules
=================

type -> ClassTypes
__self__ -> self
name.isidentifier() -> _isidentifier(name)
super -> _super

:Homepage: `Mock Homepage`_
:Download: `Mock on PyPI`_
:Documentation: `Python Docs`_
:License: `BSD License`_
:Support: `Mailing list (testing-in-python@lists.idyll.org)
<http://lists.idyll.org/listinfo/testing-in-python>`_
:Issue tracker: `Github Issues
<https://github.com/testing-cabal/mock/issues>`_
:Build status:
.. image:: https://travis-ci.org/testing-cabal/mock.svg?branch=master
:target: https://travis-ci.org/testing-cabal/mock

.. _Mock Homepage: https://github.com/testing-cabal/mock
.. _BSD License: http://github.com/testing-cabal/mock/blob/master/LICENSE.txt
.. _Python Docs: https://docs.python.org/dev/library/unittest.mock.html
.. _mock on PyPI: http://pypi.python.org/pypi/mock
Loading

0 comments on commit 18c9bbd

Please sign in to comment.