pax_global_header00006660000000000000000000000064146531250730014520gustar00rootroot0000000000000052 comment=f54e57175a388e9f7399284dc94f362a07b7a654 sphinx-removed-in-0.2.3/000077500000000000000000000000001465312507300150765ustar00rootroot00000000000000sphinx-removed-in-0.2.3/.github/000077500000000000000000000000001465312507300164365ustar00rootroot00000000000000sphinx-removed-in-0.2.3/.github/workflows/000077500000000000000000000000001465312507300204735ustar00rootroot00000000000000sphinx-removed-in-0.2.3/.github/workflows/main.yml000066400000000000000000000010321465312507300221360ustar00rootroot00000000000000name: Test on: [push, pull_request] jobs: build: runs-on: ubuntu-latest strategy: matrix: python-version: ['3.8', '3.9', '3.10', '3.11'] steps: - name: Checkout the repository uses: actions/checkout@v2 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-version }} - name: Install test dependencies run: python -m pip install -r tests/requirements.txt - name: Run tests run: make test sphinx-removed-in-0.2.3/.gitignore000066400000000000000000000000631465312507300170650ustar00rootroot00000000000000*.pyc *.pyo __pycache__/ *.eggs/ *.egg-info/ dist/ sphinx-removed-in-0.2.3/LICENSE000066400000000000000000000027751465312507300161160ustar00rootroot00000000000000Copyright (c) 2016, Alexander Todorov Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 3. Neither the name of sphinx-removed-in 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 OWNER 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. sphinx-removed-in-0.2.3/Makefile000066400000000000000000000012141465312507300165340ustar00rootroot00000000000000test: flake8 setup.py sphinx_removed_in tests python -m pytest -v build: test ./setup.py sdist upload: test ./setup.py sdist upload clean: ./setup.py clean rm -rf *.egg-info/ rm -f *.pyc sphinx_removed_in/*.pyc distclean: clean rm -rf dist/ help: @echo "Usage: make " @echo " " @echo " test - run the tests " @echo " build - build the package " @echo " upload - upload to PyPI " @echo " clean - remove all build files " @echo " distclean - remove all non git files " @echo " help - show this help and exit " sphinx-removed-in-0.2.3/README.rst000066400000000000000000000022721465312507300165700ustar00rootroot00000000000000Sphinx Removed In Extension --------------------------- .. image:: https://travis-ci.org/MrSenko/sphinx-removed-in.svg?branch=master :target: https://travis-ci.org/MrSenko/sphinx-removed-in .. image:: https://coveralls.io/repos/github/MrSenko/sphinx-removed-in/badge.svg?branch=master :target: https://coveralls.io/github/MrSenko/sphinx-removed-in?branch=master .. image:: https://landscape.io/github/MrSenko/sphinx-removed-in/master/landscape.svg?style=flat :target: https://landscape.io/github/MrSenko/sphinx-removed-in/master :alt: Code Health This is a Sphinx extension which recognizes the ``.. versionremoved::`` and ``.. removed-in::`` directives. These are missing from Sphinx'es `core markup `_. Installation ============ Use pip to install from PyPI: :: pip install sphinx-removed-in Configure your ``conf.py``: :: # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx_removed_in'] Contributing ============ Source code and issue tracker are at https://github.com/MrSenko/sphinx-removed-in sphinx-removed-in-0.2.3/docs/000077500000000000000000000000001465312507300160265ustar00rootroot00000000000000sphinx-removed-in-0.2.3/docs/conf.py000066400000000000000000000000711465312507300173230ustar00rootroot00000000000000master_doc = 'index' extensions = ['sphinx_removed_in'] sphinx-removed-in-0.2.3/docs/index.rst000066400000000000000000000001411465312507300176630ustar00rootroot00000000000000 This is the documentation for sphinx-removed-in. .. versionremoved:: 1.2 .. removed-in:: 3.2 sphinx-removed-in-0.2.3/setup.py000077500000000000000000000025631465312507300166210ustar00rootroot00000000000000#!/usr/bin/env python from setuptools import setup, find_packages __version__ = __import__('sphinx_removed_in').__version__ with open('README.rst') as file: long_description = file.read() config = { 'name': 'sphinx-removed-in', 'version': __version__, 'packages': find_packages(exclude=['tests']), 'author': 'Alexander Todorov', 'author_email': 'atodorov@MrSenko.com', 'license': 'BSD', 'description': 'versionremoved and removed-in directives for Sphinx', 'long_description': long_description, 'url': 'https://github.com/MrSenko/sphinx-removed-in', 'keywords': ['Sphinx'], 'classifiers': [ 'Development Status :: 5 - Production/Stable', 'Environment :: Console', 'Environment :: Web Environment', 'Framework :: Sphinx', 'Framework :: Sphinx :: Extension', 'Intended Audience :: Developers', 'Intended Audience :: Education', 'License :: OSI Approved :: BSD License', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 3', 'Topic :: Documentation', 'Topic :: Documentation :: Sphinx', 'Topic :: Text Processing', 'Topic :: Utilities', ], 'zip_safe': False, 'install_requires': ['Sphinx'], } setup(**config) sphinx-removed-in-0.2.3/sphinx_removed_in/000077500000000000000000000000001465312507300206165ustar00rootroot00000000000000sphinx-removed-in-0.2.3/sphinx_removed_in/__init__.py000066400000000000000000000014421465312507300227300ustar00rootroot00000000000000__version__ = '0.2.3' def setup(app): try: from sphinx.domains.changeset import versionlabels except ImportError: from sphinx.locale import versionlabels from sphinx.domains.changeset import VersionChange try: from sphinx.domains.changeset import versionlabel_classes except ImportError: versionlabel_classes = {} # dummy dict for Sphinx < 2 for _directive in ['versionremoved', 'removed-in']: if _directive not in versionlabels: versionlabels[_directive] = 'Removed in version %s' versionlabel_classes[_directive] = 'removed' app.add_directive(_directive, VersionChange) return { 'version': __version__, 'parallel_read_safe': True, 'parallel_write_safe': True, } sphinx-removed-in-0.2.3/tests/000077500000000000000000000000001465312507300162405ustar00rootroot00000000000000sphinx-removed-in-0.2.3/tests/__init__.py000066400000000000000000000000001465312507300203370ustar00rootroot00000000000000sphinx-removed-in-0.2.3/tests/conftest.py000066400000000000000000000000531465312507300204350ustar00rootroot00000000000000pytest_plugins = 'sphinx.testing.fixtures' sphinx-removed-in-0.2.3/tests/requirements.txt000066400000000000000000000000361465312507300215230ustar00rootroot00000000000000Sphinx flake8 coverage pytest sphinx-removed-in-0.2.3/tests/test_extension.py000066400000000000000000000011441465312507300216650ustar00rootroot00000000000000import os import sys import pytest PARENT = os.path.join(os.path.dirname(os.path.abspath(__file__)), '..') sys.path.insert(0, PARENT) @pytest.mark.sphinx(buildername='html', srcdir=os.path.join(PARENT, 'docs')) def test_sphinx_build(app, status, warning): app.build() try: html = (app.outdir / 'index.html').read_text() except AttributeError: # an older version of sphinx (used e.g. on Python 2) # use the now deprecated API instead html = (app.outdir / 'index.html').text() assert 'Removed in version 1.2' in html assert 'Removed in version 3.2' in html