pax_global_header 0000666 0000000 0000000 00000000064 14400227546 0014516 g ustar 00root root 0000000 0000000 52 comment=e7380e08d4898136408b9f175b7cd62781a4cb5b sphinx-favicon-1.0.1/ 0000775 0000000 0000000 00000000000 14400227546 0014451 5 ustar 00root root 0000000 0000000 sphinx-favicon-1.0.1/.github/ 0000775 0000000 0000000 00000000000 14400227546 0016011 5 ustar 00root root 0000000 0000000 sphinx-favicon-1.0.1/.github/workflows/ 0000775 0000000 0000000 00000000000 14400227546 0020046 5 ustar 00root root 0000000 0000000 sphinx-favicon-1.0.1/.github/workflows/basic-ci.yml 0000664 0000000 0000000 00000002153 14400227546 0022244 0 ustar 00root root 0000000 0000000 name: Python lint and test on: push: branches: [ main ] pull_request: branches: [ main ] jobs: format: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - uses: actions/setup-python@v4 with: python-version: '3.8' - uses: pre-commit/action@v3.0.0 test: runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-latest] python-version: ['3.7', '3.8', '3.9', '3.10'] include: - os: macos-latest python-version: '3.9' - os: windows-latest python-version: '3.9' steps: - uses: actions/checkout@v3 - name: Setup Python uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: pip install .[test] - name: MyPy checks run: | pip install mypy mypy --ignore-missing-imports --install-types --non-interactive sphinx_favicon - name: Run Tests for ${{ matrix.python-version }} run: pytest --color=yes --cov --cov-report=xml tests sphinx-favicon-1.0.1/.gitignore 0000664 0000000 0000000 00000003432 14400227546 0016443 0 ustar 00root root 0000000 0000000 # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ pip-wheel-metadata/ share/python-wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 db.sqlite3-journal # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder target/ # Jupyter Notebook .ipynb_checkpoints # IPython profile_default/ ipython_config.py # pyenv .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. # However, in case of collaboration, if having platform-specific dependencies or dependencies # having no cross-platform support, pipenv may install dependencies that don't work, or not # install all needed dependencies. #Pipfile.lock # PEP 582; used by e.g. github.com/David-OConnor/pyflow __pypackages__/ # Celery stuff celerybeat-schedule celerybeat.pid # SageMath parsed files *.sage.py # Environments .env .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ .dmypy.json dmypy.json # Pyre type checker .pyre/ # VSCode .vscode/ sphinx-favicon-1.0.1/.pre-commit-config.yaml 0000664 0000000 0000000 00000000433 14400227546 0020732 0 ustar 00root root 0000000 0000000 repos: - repo: "https://github.com/psf/black" rev: 22.3.0 hooks: - id: black stages: [commit] - repo: https://github.com/charliermarsh/ruff-pre-commit rev: "v0.0.217" hooks: - id: ruff stages: [commit] args: ["--force-exclude"] sphinx-favicon-1.0.1/.readthedocs.yml 0000664 0000000 0000000 00000000766 14400227546 0017550 0 ustar 00root root 0000000 0000000 # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 # Set the version of Python and other tools you might need build: os: ubuntu-22.04 tools: python: "3.10" # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py # Optionally declare the Python requirements required to build your docs python: install: - method: pip path: .[doc] sphinx-favicon-1.0.1/CHANGELOG 0000664 0000000 0000000 00000007540 14400227546 0015671 0 ustar 00root root 0000000 0000000 # 2023-03-02, Release 1.0.1 This is a bugfix for Release 1.0 and contains only one change. ## What's Changed * fix: don't use relative path to _static output folder by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/46 **Full Changelog**: https://github.com/tcmetzger/sphinx-favicon/compare/v1.0...v1.1 # 2023-03-01, Release 1.0 1.0 is the first major release of Sphinx Favicon. It 1.0 brings one **breaking change**: To better conform with Python standards, the extension module name was changed from `sphinx-favicon` to `sphinx_favicon`. If you have used previous version of this extension, you need to update your `conf.py` file to use `sphinx_favicon` (instead of the old name, `sphinx-favicon`) Otherwise, your existing configuration should work without any changes. The 1.0 release contains lots of updates and new features, including [automatic detection of favicon pixel dimensions] (https://sphinx-favicon.readthedocs.io/en/latest/configuration.html#sizes-the-image-size), [basic support for additional favicon formats](https://sphinx-favicon.readthedocs.io/en/latest/configuration.html#name-specific-to-msapp-icons), and a new, [Sphinx-based documentation site at https://sphinx-favicon.readthedocs.io](https://sphinx-favicon.readthedocs.io). ## What's Changed * change folder name by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/13 * Use pre-commit to enforce linting by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/14 * Update ci by @tcmetzger in https://github.com/tcmetzger/sphinx-favicon/pull/17 * Add sphinx docs by @tcmetzger in https://github.com/tcmetzger/sphinx-favicon/pull/18 * Update docs config by @tcmetzger in https://github.com/tcmetzger/sphinx-favicon/pull/19 * Mypy by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/20 * authorize any parameter in the favicon dict by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/24 * Delete .gitattributes by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/29 * update documentation by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/27 * refactor: Simplify favicon parsing by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/30 * edit announcement link by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/31 * Meta by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/25 * compute size automatically if not set by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/26 * resize mstile to 150x150 by @tcmetzger in https://github.com/tcmetzger/sphinx-favicon/pull/33 * use only pyproject.toml for build by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/34 * refactor documentation by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/35 * Fix typo by @tcmetzger in https://github.com/tcmetzger/sphinx-favicon/pull/36 * Update tests by @tcmetzger in https://github.com/tcmetzger/sphinx-favicon/pull/37 * fixed `documentation` and `contribution` broken links by @adityakode in https://github.com/tcmetzger/sphinx-favicon/pull/40 * Docs updates by @tcmetzger in https://github.com/tcmetzger/sphinx-favicon/pull/41 * fix: remove download url by @12rambau in https://github.com/tcmetzger/sphinx-favicon/pull/42 * Update docs for release by @tcmetzger in https://github.com/tcmetzger/sphinx-favicon/pull/43 ## New Contributors * @12rambau made their first contribution in https://github.com/tcmetzger/sphinx-favicon/pull/13 * @adityakode made their first contribution in https://github.com/tcmetzger/sphinx-favicon/pull/40 **Full Changelog**: https://github.com/tcmetzger/sphinx-favicon/compare/v0.2...v1.0 # 2021-11-15, Release 0.2 - Add support for relative files (#2) - Add basic tests (#3) - Test on multiple os (#5) ## New Contributors * @abravalheri made their first contribution in https://github.com/tcmetzger/sphinx-favicon/pull/2 # 2021-10-03, Release 0.1 Initial release sphinx-favicon-1.0.1/LICENSE 0000664 0000000 0000000 00000002067 14400227546 0015463 0 ustar 00root root 0000000 0000000 MIT License Copyright (c) 2021 Timo Cornelius Metzger 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-favicon-1.0.1/README.md 0000664 0000000 0000000 00000006623 14400227546 0015737 0 ustar 00root root 0000000 0000000 # Sphinx Favicon [](https://opensource.org/licenses/MIT) [](https://github.com/psf/black) [](https://pypi.org/project/sphinx-favicon/)    > **Note: Updating from Version 0.2 to Version 1.0** > > Between v0.2 and v1.0, the module name of the extension changed to better conform with Python standards. Please update the name used in the extension list of your `conf.py` from `sphinx-favicon` to `sphinx_favicon`! **A Sphinx extension to add custom favicons** With Sphinx Favicon, you can add custom favicons to your Sphinx html documentation quickly and easily. You can define favicons directly in your `conf.py`, with different `rel` attributes such as [`"icon"`](https://html.spec.whatwg.org/multipage/links.html#rel-icon) or [`"apple-touch-icon"`](https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html) and any favicon size. The Sphinx Favicon extension gives you more flexibility than the [standard `favicon.ico` supported by Sphinx](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon). It provides a quick and easy way to add the most important favicon formats for different browsers and devices. ## Installation Use ``pip`` to install Sphinx Favicon in your environment: ```sh pip install sphinx-favicon ``` ## Usage After installing **sphinx-favicon**, add it to your `conf.py` extension list: ```python extensions = ["sphinx_favicon"] ``` Then configure the favicon links using the `favicons` parameter (`html_static_path` is mandatory if you use relative path): ```python html_static_path = ["_static"] favicons = [ {"href": "icon.svg"}, # => use `_static/icon.svg` {"href": "https://secure.example.com/favicon/favicon-16x16.png"}, {"href": "https://secure.example.com/favicon/favicon-32x32.png"}, { "rel": "apple-touch-icon", "href": "https://secure.example.com/favicon/apple-touch-icon-180x180.png", }, ] ``` Based on this configuration, Sphinx will include the following favicon information in the HTML `
` element: ```html ``` For more details and more advanced usage, please see the [documentation](https://sphinx-favicon.readthedocs.io). ## Contribution Contributions of any kind are welcome. Please see the [contribution](https://sphinx-favicon.readthedocs.io/en/latest/contribute.html) section of our documentation for more information. sphinx-favicon-1.0.1/docs/ 0000775 0000000 0000000 00000000000 14400227546 0015401 5 ustar 00root root 0000000 0000000 sphinx-favicon-1.0.1/docs/source/ 0000775 0000000 0000000 00000000000 14400227546 0016701 5 ustar 00root root 0000000 0000000 sphinx-favicon-1.0.1/docs/source/_static/ 0000775 0000000 0000000 00000000000 14400227546 0020327 5 ustar 00root root 0000000 0000000 sphinx-favicon-1.0.1/docs/source/_static/android-chrome-192x192.png 0000664 0000000 0000000 00000014333 14400227546 0024671 0 ustar 00root root 0000000 0000000 PNG IHDR դ gAMA a cHRM z&