| Name | pytest-sphinx JSON |
| Version |
0.6.3
JSON |
| download |
| home_page | None |
| Summary | Doctest plugin for pytest with support for Sphinx-specific doctest-directives |
| upload_time | 2024-04-13 19:11:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Copyright (c) 2017-2024, Thomas Wimmer All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of pytest-sphinx nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
sphinx
pytest
rst
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=============
pytest-sphinx
=============
.. image:: https://github.com/thisch/pytest-sphinx/workflows/Test/badge.svg
:target: https://github.com/thisch/pytest-sphinx/actions
:alt: Action Status
A doctest plugin for pytest, which understands the sphinx-specific
directives from `doctest-sphinx`_. Those sphinx-specific directives can be
used in rst files as well as in docstrings of python modules.
Features
--------
* support for the ``doctest`` directive
* support for ``testcode`` and ``testoutput`` directives
* support for ``testsetup`` and ``testcleanup`` is planned (pull-requests welcome)
* support for parsing global optionflags (``doctest_optionflags``) from
``pytest.ini``
* support for ``:options:`` in ``testoutput``
* support for ``:skipif:`` in ``testcode`` and in ``testoutput``
* ``:hide:`` is ignored by "pytest-sphinx"
Requirements
------------
* pytest
Installation
------------
You can install "pytest-sphinx" via `pip`_ from `PyPI`_::
$ pip install pytest-sphinx
Usage
-----
* See `doctest-sphinx`_. Have a look at the examples in `doctest-examples`_.
* Run pytest with the `--doctest-modules` flag.
Contributing
------------
Contributions are very welcome. Tests can be run with `tox`_, please ensure
the coverage at least stays the same before you submit a pull request.
License
-------
Distributed under the terms of the `BSD-3`_ license, "pytest-sphinx" is free and open source software
Issues
------
If you encounter any problems, please `file an issue`_ along with a detailed description.
.. _`doctest-sphinx`: http://www.sphinx-doc.org/en/stable/ext/doctest.html
.. _`doctest-examples`: https://github.com/sphinx-doc/sphinx/blob/master/tests/roots/test-ext-doctest/doctest.txt
.. _`@hackebrot`: https://github.com/hackebrot
.. _`MIT`: http://opensource.org/licenses/MIT
.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`file an issue`: https://github.com/thisch/pytest-sphinx/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.io/en/latest/
.. _`pip`: https://pypi.python.org/pypi/pip/
.. _`PyPI`: https://pypi.python.org/pypi
Raw data
{
"_id": null,
"home_page": null,
"name": "pytest-sphinx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Thomas Wimmer <thomaswimmer@posteo.com>",
"keywords": "sphinx, pytest, rst",
"author": null,
"author_email": "Thomas Wimmer <thomaswimmer@posteo.com>",
"download_url": "https://files.pythonhosted.org/packages/8f/12/a6e99712955b7057accbe43f7f709cf212e6fc00f570bfdc93574335ba5b/pytest_sphinx-0.6.3.tar.gz",
"platform": null,
"description": "=============\npytest-sphinx\n=============\n\n.. image:: https://github.com/thisch/pytest-sphinx/workflows/Test/badge.svg\n :target: https://github.com/thisch/pytest-sphinx/actions\n :alt: Action Status\n\nA doctest plugin for pytest, which understands the sphinx-specific\ndirectives from `doctest-sphinx`_. Those sphinx-specific directives can be\nused in rst files as well as in docstrings of python modules.\n\n\nFeatures\n--------\n\n* support for the ``doctest`` directive\n* support for ``testcode`` and ``testoutput`` directives\n* support for ``testsetup`` and ``testcleanup`` is planned (pull-requests welcome)\n* support for parsing global optionflags (``doctest_optionflags``) from\n ``pytest.ini``\n* support for ``:options:`` in ``testoutput``\n* support for ``:skipif:`` in ``testcode`` and in ``testoutput``\n* ``:hide:`` is ignored by \"pytest-sphinx\"\n\n\nRequirements\n------------\n\n* pytest\n\n\nInstallation\n------------\n\nYou can install \"pytest-sphinx\" via `pip`_ from `PyPI`_::\n\n $ pip install pytest-sphinx\n\n\nUsage\n-----\n\n* See `doctest-sphinx`_. Have a look at the examples in `doctest-examples`_.\n* Run pytest with the `--doctest-modules` flag.\n\n\nContributing\n------------\nContributions are very welcome. Tests can be run with `tox`_, please ensure\nthe coverage at least stays the same before you submit a pull request.\n\n\nLicense\n-------\n\nDistributed under the terms of the `BSD-3`_ license, \"pytest-sphinx\" is free and open source software\n\n\nIssues\n------\n\nIf you encounter any problems, please `file an issue`_ along with a detailed description.\n\n.. _`doctest-sphinx`: http://www.sphinx-doc.org/en/stable/ext/doctest.html\n.. _`doctest-examples`: https://github.com/sphinx-doc/sphinx/blob/master/tests/roots/test-ext-doctest/doctest.txt\n.. _`@hackebrot`: https://github.com/hackebrot\n.. _`MIT`: http://opensource.org/licenses/MIT\n.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause\n.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt\n.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0\n.. _`file an issue`: https://github.com/thisch/pytest-sphinx/issues\n.. _`pytest`: https://github.com/pytest-dev/pytest\n.. _`tox`: https://tox.readthedocs.io/en/latest/\n.. _`pip`: https://pypi.python.org/pypi/pip/\n.. _`PyPI`: https://pypi.python.org/pypi\n",
"bugtrack_url": null,
"license": " Copyright (c) 2017-2024, Thomas Wimmer All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of pytest-sphinx nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Doctest plugin for pytest with support for Sphinx-specific doctest-directives",
"version": "0.6.3",
"project_urls": {
"homepage": "https://github.com/thisch/pytest-sphinx"
},
"split_keywords": [
"sphinx",
" pytest",
" rst"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "70db79570f7eebfa0f24b670d985423f4fa45fee67ef8feb25c6b58cbe2b0bb7",
"md5": "352c033e7e657e4e0c8f07f53c10644a",
"sha256": "856e760e64dfbfc89e362e187d641140a267b97881d3ef8aeefb72cc8438ac40"
},
"downloads": -1,
"filename": "pytest_sphinx-0.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "352c033e7e657e4e0c8f07f53c10644a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10349,
"upload_time": "2024-04-13T19:11:50",
"upload_time_iso_8601": "2024-04-13T19:11:50.394328Z",
"url": "https://files.pythonhosted.org/packages/70/db/79570f7eebfa0f24b670d985423f4fa45fee67ef8feb25c6b58cbe2b0bb7/pytest_sphinx-0.6.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f12a6e99712955b7057accbe43f7f709cf212e6fc00f570bfdc93574335ba5b",
"md5": "0839b97a1f0c3c3e49cbaeef4d2edfa7",
"sha256": "3b63c8181b9de6a5e5c9826d1b4dc0c827245bec8e64c9f16f269be08be5ecd5"
},
"downloads": -1,
"filename": "pytest_sphinx-0.6.3.tar.gz",
"has_sig": false,
"md5_digest": "0839b97a1f0c3c3e49cbaeef4d2edfa7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13690,
"upload_time": "2024-04-13T19:11:51",
"upload_time_iso_8601": "2024-04-13T19:11:51.905672Z",
"url": "https://files.pythonhosted.org/packages/8f/12/a6e99712955b7057accbe43f7f709cf212e6fc00f570bfdc93574335ba5b/pytest_sphinx-0.6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 19:11:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thisch",
"github_project": "pytest-sphinx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pytest-sphinx"
}
