sphinx-codeautolink 0.15.2__tar.gz → 0.16.0__tar.gz

{sphinx_codeautolink-0.15.2 → sphinx_codeautolink-0.16.0}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021-2023 Felix Hildén
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021-2025 Felix Hildén
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{sphinx_codeautolink-0.15.2 → sphinx_codeautolink-0.16.0}/MANIFEST.in

@@ -1,6 +1,6 @@
-graft docs
-prune docs/build
-graft requirements
-graft tests
-include contributing.rst readme_pypi.rst tox.ini
-global-exclude *.py[cod] __pycache__ *.so
+graft docs
+prune docs/build
+graft requirements
+graft tests
+include contributing.rst readme_pypi.rst tox.ini
+global-exclude *.py[cod] __pycache__ *.so

{sphinx_codeautolink-0.15.2/src/sphinx_codeautolink.egg-info → sphinx_codeautolink-0.16.0}/PKG-INFO

@@ -1,105 +1,104 @@
-Metadata-Version: 2.1
-Name: sphinx-codeautolink
-Version: 0.15.2
-Summary: Automatic links from code examples to reference documentation.
-Author-email: Felix Hildén <felix.hilden@gmail.com>
-Maintainer-email: Felix Hildén <felix.hilden@gmail.com>
-License: MIT License
-        
-        Copyright (c) 2021-2023 Felix Hildén
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Project-URL: homepage, https://pypi.org/project/sphinx-codeautolink
-Project-URL: download, https://pypi.org/project/sphinx-codeautolink
-Project-URL: source, https://github.com/felix-hilden/sphinx-codeautolink
-Project-URL: issues, https://github.com/felix-hilden/sphinx-codeautolink/issues
-Project-URL: documentation, https://sphinx-codeautolink.rtfd.org
-Keywords: sphinx,extension,code,link
-Classifier: Development Status :: 4 - Beta
-Classifier: Framework :: Sphinx
-Classifier: Framework :: Sphinx :: Extension
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Documentation
-Classifier: Topic :: Documentation :: Sphinx
-Classifier: Topic :: Software Development :: Documentation
-Requires-Python: >=3.7
-Description-Content-Type: text/x-rst
-License-File: LICENSE
-Requires-Dist: sphinx>=3.2.0
-Requires-Dist: beautifulsoup4>=4.8.1
-Provides-Extra: ipython
-Requires-Dist: ipython!=8.7.0; extra == "ipython"
-
-sphinx-codeautolink
-===================
-|pyversions| |downloads| |license| |readthedocs|
-
-sphinx-codeautolink makes code examples clickable by inserting links
-from individual code elements to the corresponding reference documentation.
-We aim for a minimal setup assuming your examples are already valid Python.
-
-For a live demo, see our online documentation on
-`Read The Docs <https://sphinx-codeautolink.rtfd.org>`_.
-
-Installation
-------------
-sphinx-codeautolink can be installed from the following sources:
-
-.. code:: sh
-
-    $ pip install sphinx-codeautolink
-    # or, alternatively:
-    $ conda install -c conda-forge sphinx-codeautolink
-
-Note that the library is in early development, so version pinning is advised.
-To enable sphinx-codeautolink, modify the extension list in ``conf.py``.
-Note that the extension name uses an underscore rather than a hyphen.
-
-.. code:: python
-
-   extensions = [
-       ...,
-       "sphinx_codeautolink",
-   ]
-
-That's it! Now your code examples are linked.
-For ways of concatenating multiple examples
-and setting default import statements among other things,
-have a look at the online documentation.
-
-.. |pyversions| image:: https://img.shields.io/pypi/pyversions/sphinx-codeautolink
-   :alt: Python versions
-
-.. |downloads| image:: https://img.shields.io/pypi/dm/sphinx-codeautolink
-   :alt: Monthly downloads
-
-.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
-   :target: https://choosealicense.com/licenses/mit
-   :alt: License: MIT
-
-.. |readthedocs| image:: https://rtfd.org/projects/sphinx-codeautolink/badge/?version=stable
-   :target: https://sphinx-codeautolink.rtfd.org/en/stable/
-   :alt: Documentation
+Metadata-Version: 2.2
+Name: sphinx-codeautolink
+Version: 0.16.0
+Summary: Automatic links from code examples to reference documentation.
+Author-email: Felix Hildén <felix.hilden@gmail.com>
+Maintainer-email: Felix Hildén <felix.hilden@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2021-2025 Felix Hildén
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: homepage, https://pypi.org/project/sphinx-codeautolink
+Project-URL: download, https://pypi.org/project/sphinx-codeautolink
+Project-URL: source, https://github.com/felix-hilden/sphinx-codeautolink
+Project-URL: issues, https://github.com/felix-hilden/sphinx-codeautolink/issues
+Project-URL: documentation, https://sphinx-codeautolink.rtfd.org
+Keywords: sphinx,extension,code,link
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: sphinx>=3.2.0
+Requires-Dist: beautifulsoup4>=4.8.1
+Provides-Extra: ipython
+Requires-Dist: ipython!=8.7.0; extra == "ipython"
+
+sphinx-codeautolink
+===================
+|pyversions| |downloads| |license| |readthedocs|
+
+sphinx-codeautolink makes code examples clickable by inserting links
+from individual code elements to the corresponding reference documentation.
+We aim for a minimal setup assuming your examples are already valid Python.
+
+For a live demo, see our online documentation on
+`Read The Docs <https://sphinx-codeautolink.rtfd.org>`_.
+
+Installation
+------------
+sphinx-codeautolink can be installed from the following sources:
+
+.. code:: sh
+
+    $ pip install sphinx-codeautolink
+    # or, alternatively:
+    $ conda install -c conda-forge sphinx-codeautolink
+
+Note that the library is in early development, so version pinning is advised.
+To enable sphinx-codeautolink, modify the extension list in ``conf.py``.
+Note that the extension name uses an underscore rather than a hyphen.
+
+.. code:: python
+
+   extensions = [
+       ...,
+       "sphinx_codeautolink",
+   ]
+
+That's it! Now your code examples are linked.
+For ways of concatenating multiple examples
+and setting default import statements among other things,
+have a look at the online documentation.
+
+.. |pyversions| image:: https://img.shields.io/pypi/pyversions/sphinx-codeautolink
+   :alt: Python versions
+
+.. |downloads| image:: https://img.shields.io/pypi/dm/sphinx-codeautolink
+   :alt: Monthly downloads
+
+.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
+   :target: https://choosealicense.com/licenses/mit
+   :alt: License: MIT
+
+.. |readthedocs| image:: https://rtfd.org/projects/sphinx-codeautolink/badge/?version=stable
+   :target: https://sphinx-codeautolink.rtfd.org/en/stable/
+   :alt: Documentation

{sphinx_codeautolink-0.15.2 → sphinx_codeautolink-0.16.0}/contributing.rst

@@ -1,94 +1,94 @@
-Contributing
-============
-|issues_open| |issue_resolution|
-
-Thank you for considering contributing to sphinx-codeautolink!
-If you've found a bug or would like to propose a feature,
-please submit an `issue <https://github.com/felix-hilden/sphinx-codeautolink/issues>`_.
-
-If you'd like to get more involved,
-`here's how <https://opensource.guide/how-to-contribute/>`_.
-There are many valuable contributions in addition to contributing code!
-If you're so inclined, triaging issues, improving documentation,
-helping other users and reviewing existing code and PRs is equally appreciated!
-
-The rest of this guide focuses on development and code contributions.
-
-Installation
-------------
-Start by cloning the most recent version, either from the main repository
-or a fork you created, and installing the source as an editable package.
-Using a virtual environment of your choice for the installation is recommended.
-
-.. code:: sh
-
-    $ git clone https://github.com/felix-hilden/sphinx-codeautolink.git
-    $ cd sphinx-codeautolink
-    $ pip install -e .
-    $ pip install -r requirements/dev
-
-The last command installs all the necessary tools for development
-as well as all optional dependencies.
-
-If you forked, consider adding the upstream repository as a remote to easily
-update your main branch with the latest upstream changes.
-For tips and tricks on contributing, see `how to submit a contribution
-<https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution>`_,
-specifically `opening a pull request
-<https://opensource.guide/how-to-contribute/#opening-a-pull-request>`_.
-
-Testing
--------
-The installation can be verified, and any changes tested by running tox.
-
-.. code:: sh
-
-    $ tox
-
-Developing
-----------
-A number of tools are used to automate development tasks.
-They are available through tox labels.
-
-.. code:: sh
-
-    $ coverage run && coverage report  # execute test suite
-    $ tox -m docs  # build documentation to docs/build/html/index.html
-    $ tox -m lint  # check code style
-    $ tox -m format  # autoformat code
-    $ tox -m build  # packaging dry run
-
-Releasing
----------
-Before releasing, make sure the version number is incremented
-and the release notes reference the new release.
-
-.. note::
-
-    With sphinx-codeautolink specifically, if Sphinx's environment data
-    structure was modified, increment the environment version number before
-    releasing a new version.
-
-Running tests once more is also good practice.
-Tox is used to build the appropriate distributions and publish them on PyPI.
-
-.. code:: sh
-
-    $ tox -m publish
-
-If you'd like to test the upload and the resulting package,
-upload manually to `TestPyPI <https://test.pypi.org>`_ instead.
-
-.. code:: sh
-
-    $ python -m build
-    $ twine upload --repository testpypi dist/*
-    $ pip install --index-url https://test.pypi.org/simple/ sphinx-codeautolink
-
-.. |issue_resolution| image:: http://isitmaintained.com/badge/resolution/felix-hilden/sphinx-codeautolink.svg
-   :target: https://isitmaintained.com/project/felix-hilden/sphinx-codeautolink
-   :alt: issue resolution time
-
-.. |issues_open| image:: http://isitmaintained.com/badge/open/felix-hilden/sphinx-codeautolink.svg
-   :target: https://isitmaintained.com/project/felix-hilden/sphinx-codeautolink
-   :alt: open issues
+Contributing
+============
+|issues_open| |issue_resolution|
+
+Thank you for considering contributing to sphinx-codeautolink!
+If you've found a bug or would like to propose a feature,
+please submit an `issue <https://github.com/felix-hilden/sphinx-codeautolink/issues>`_.
+
+If you'd like to get more involved,
+`here's how <https://opensource.guide/how-to-contribute/>`_.
+There are many valuable contributions in addition to contributing code!
+If you're so inclined, triaging issues, improving documentation,
+helping other users and reviewing existing code and PRs is equally appreciated!
+
+The rest of this guide focuses on development and code contributions.
+
+Installation
+------------
+Start by cloning the most recent version, either from the main repository
+or a fork you created, and installing the source as an editable package.
+Using a virtual environment of your choice for the installation is recommended.
+
+.. code:: sh
+
+    $ git clone https://github.com/felix-hilden/sphinx-codeautolink.git
+    $ cd sphinx-codeautolink
+    $ pip install -e .
+    $ pip install -r requirements/dev
+
+The last command installs all the necessary tools for development
+as well as all optional dependencies.
+
+If you forked, consider adding the upstream repository as a remote to easily
+update your main branch with the latest upstream changes.
+For tips and tricks on contributing, see `how to submit a contribution
+<https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution>`_,
+specifically `opening a pull request
+<https://opensource.guide/how-to-contribute/#opening-a-pull-request>`_.
+
+Testing
+-------
+The installation can be verified, and any changes tested by running tox.
+
+.. code:: sh
+
+    $ tox
+
+Developing
+----------
+A number of tools are used to automate development tasks.
+They are available through tox labels.
+
+.. code:: sh
+
+    $ coverage run && coverage report  # execute test suite
+    $ tox -m docs  # build documentation to docs/build/html/index.html
+    $ tox -m lint  # check code style
+    $ tox -m format  # autoformat code
+    $ tox -m build  # packaging dry run
+
+Releasing
+---------
+Before releasing, make sure the version number is incremented
+and the release notes reference the new release.
+
+.. note::
+
+    With sphinx-codeautolink specifically, if Sphinx's environment data
+    structure was modified, increment the environment version number before
+    releasing a new version.
+
+Running tests once more is also good practice.
+Tox is used to build the appropriate distributions and publish them on PyPI.
+
+.. code:: sh
+
+    $ tox -m publish
+
+If you'd like to test the upload and the resulting package,
+upload manually to `TestPyPI <https://test.pypi.org>`_ instead.
+
+.. code:: sh
+
+    $ python -m build
+    $ twine upload --repository testpypi dist/*
+    $ pip install --index-url https://test.pypi.org/simple/ sphinx-codeautolink
+
+.. |issue_resolution| image:: http://isitmaintained.com/badge/resolution/felix-hilden/sphinx-codeautolink.svg
+   :target: https://isitmaintained.com/project/felix-hilden/sphinx-codeautolink
+   :alt: issue resolution time
+
+.. |issues_open| image:: http://isitmaintained.com/badge/open/felix-hilden/sphinx-codeautolink.svg
+   :target: https://isitmaintained.com/project/felix-hilden/sphinx-codeautolink
+   :alt: open issues

{sphinx_codeautolink-0.15.2 → sphinx_codeautolink-0.16.0}/docs/requirements.txt

@@ -1,6 +1,6 @@
-# Manually pin Sphinx + docs requirements
-sphinx==7.2.6
-sphinx-rtd-theme==2.0.0
-docutils==0.19
-matplotlib==3.8.3
-ipython==8.22.2
+# Manually pin Sphinx + docs requirements
+sphinx==7.2.6
+sphinx-rtd-theme==2.0.0
+docutils==0.19
+matplotlib==3.8.3
+ipython==8.22.2

{sphinx_codeautolink-0.15.2 → sphinx_codeautolink-0.16.0}/docs/src/404.rst

@@ -1,10 +1,10 @@
-:orphan:
-
-sphinx-codeautolink
-===================
-
-Oops! The page you are looking for was not found.
-Maybe you'll find what you're looking for by searching the documentation
-or returning to the `home page <rtd_>`_.
-
-.. _rtd: https://sphinx-codeautolink.rtfd.org
+:orphan:
+
+sphinx-codeautolink
+===================
+
+Oops! The page you are looking for was not found.
+Maybe you'll find what you're looking for by searching the documentation
+or returning to the `home page <rtd_>`_.
+
+.. _rtd: https://sphinx-codeautolink.rtfd.org