├── .github └── workflows │ └── release.yml ├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── Pipfile ├── Pipfile.lock ├── README.md ├── RELEASE.md ├── backlinks_plugin ├── __init__.py └── plugin.py ├── pyproject.toml └── setup.py /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: pypi release 2 | on: 3 | push: 4 | tags: 5 | - 'v[0-9]+.[0-9]+.[0-9]+[ab]?' 6 | jobs: 7 | release: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v2 11 | with: 12 | fetch-depth: 0 13 | - uses: actions/setup-python@v3 14 | with: 15 | python-version: '3.10' 16 | cache: 'pipenv' 17 | - name: Install pipenv 18 | run: pipx install pipenv 19 | - name: Setup Environment 20 | run: pipenv install --dev 21 | - name: Build 22 | run: pipenv run python -m build 23 | - name: Create Release 24 | id: create_release 25 | uses: actions/create-release@v1 26 | env: 27 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 28 | with: 29 | tag_name: ${{ github.ref }} 30 | release_name: mkdocs-backlinks ${{ github.ref }} 31 | body_path: RELEASE.md 32 | draft: false 33 | prerelease: false 34 | - name: Set python package name 35 | run: echo "PACKAGE_FILENAME=./dist/mkdocs-backlinks-"$(echo $GITHUB_REF | cut -d'v' -f 2)".tar.gz" >> $GITHUB_ENV 36 | - name: Upload Python Package 37 | uses: actions/upload-release-asset@v1 38 | env: 39 | GITHUB_TOKEN: ${{ github.token }} 40 | with: 41 | upload_url: ${{ steps.create_release.outputs.upload_url }} 42 | asset_path: ${{ env.PACKAGE_FILENAME }} 43 | asset_name: ${{ env.PACKAGE_FILENAME }} 44 | asset_content_type: application/gzip 45 | - name: Set python wheel name 46 | run: echo "WHEEL_FILENAME=./dist/mkdocs_backlinks-"$(echo $GITHUB_REF | cut -d'v' -f 2)"-py3-none-any.whl" >> $GITHUB_ENV 47 | - name: Upload Python Wheel 48 | uses: actions/upload-release-asset@v1 49 | env: 50 | GITHUB_TOKEN: ${{ github.token }} 51 | with: 52 | upload_url: ${{ steps.create_release.outputs.upload_url }} 53 | asset_path: ${{ env.WHEEL_FILENAME }} 54 | asset_name: ${{ env.WHEEL_FILENAME }} 55 | asset_content_type: application/x-wheel+zip 56 | - name: PyPI release 57 | uses: pypa/gh-action-pypi-publish@release/v1 58 | with: 59 | user: __token__ 60 | password: ${{ secrets.PYPI_API_TOKEN }} -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | /.vs/ 162 | /.vscode/ 163 | .idea/ -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 7 | 8 | ## [Unreleased] 9 | 10 | --- 11 | 12 | ## v0.9.1 13 | 14 | ### Changed 15 | 16 | - Add missing dependency. 17 | 18 | --- 19 | 20 | ## v0.9.0 21 | 22 | ### Added 23 | 24 | - Initial release. It generates backlinks. -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2023 Danilo Guimarães 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in all 11 | copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 19 | SOFTWARE. -------------------------------------------------------------------------------- /Pipfile: -------------------------------------------------------------------------------- 1 | [[source]] 2 | url = "https://pypi.org/simple" 3 | verify_ssl = true 4 | name = "pypi" 5 | 6 | [packages] 7 | mkdocs = "*" 8 | beautifulsoup4 = "*" 9 | 10 | [dev-packages] 11 | autopep8 = "*" 12 | twine = "*" 13 | build = "*" 14 | 15 | [requires] 16 | python_version = "3" 17 | python_full_version = "3.10.6" 18 | -------------------------------------------------------------------------------- /Pipfile.lock: -------------------------------------------------------------------------------- 1 | { 2 | "_meta": { 3 | "hash": { 4 | "sha256": "3ddf651bf3b8c1b52bc655b9131c8fe55db880a697f77876ddd85af2c182e949" 5 | }, 6 | "pipfile-spec": 6, 7 | "requires": { 8 | "python_full_version": "3.10.6", 9 | "python_version": "3" 10 | }, 11 | "sources": [ 12 | { 13 | "name": "pypi", 14 | "url": "https://pypi.org/simple", 15 | "verify_ssl": true 16 | } 17 | ] 18 | }, 19 | "default": { 20 | "beautifulsoup4": { 21 | "hashes": [ 22 | "sha256:58d5c3d29f5a36ffeb94f02f0d786cd53014cf9b3b3951d42e0080d8a9498d30", 23 | "sha256:ad9aa55b65ef2808eb405f46cf74df7fcb7044d5cbc26487f96eb2ef2e436693" 24 | ], 25 | "index": "pypi", 26 | "version": "==4.11.1" 27 | }, 28 | "click": { 29 | "hashes": [ 30 | "sha256:7682dc8afb30297001674575ea00d1814d808d6a36af415a82bd481d37ba7b8e", 31 | "sha256:bb4d8133cb15a609f44e8213d9b391b0809795062913b383c62be0ee95b1db48" 32 | ], 33 | "markers": "python_version >= '3.7'", 34 | "version": "==8.1.3" 35 | }, 36 | "ghp-import": { 37 | "hashes": [ 38 | "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619", 39 | "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343" 40 | ], 41 | "version": "==2.1.0" 42 | }, 43 | "jinja2": { 44 | "hashes": [ 45 | "sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852", 46 | "sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61" 47 | ], 48 | "markers": "python_version >= '3.7'", 49 | "version": "==3.1.2" 50 | }, 51 | "markdown": { 52 | "hashes": [ 53 | "sha256:cbb516f16218e643d8e0a95b309f77eb118cb138d39a4f27851e6a63581db874", 54 | "sha256:f5da449a6e1c989a4cea2631aa8ee67caa5a2ef855d551c88f9e309f4634c621" 55 | ], 56 | "markers": "python_version >= '3.6'", 57 | "version": "==3.3.7" 58 | }, 59 | "markupsafe": { 60 | "hashes": [ 61 | "sha256:0576fe974b40a400449768941d5d0858cc624e3249dfd1e0c33674e5c7ca7aed", 62 | "sha256:085fd3201e7b12809f9e6e9bc1e5c96a368c8523fad5afb02afe3c051ae4afcc", 63 | "sha256:090376d812fb6ac5f171e5938e82e7f2d7adc2b629101cec0db8b267815c85e2", 64 | "sha256:0b462104ba25f1ac006fdab8b6a01ebbfbce9ed37fd37fd4acd70c67c973e460", 65 | "sha256:137678c63c977754abe9086a3ec011e8fd985ab90631145dfb9294ad09c102a7", 66 | "sha256:1bea30e9bf331f3fef67e0a3877b2288593c98a21ccb2cf29b74c581a4eb3af0", 67 | "sha256:22152d00bf4a9c7c83960521fc558f55a1adbc0631fbb00a9471e097b19d72e1", 68 | "sha256:22731d79ed2eb25059ae3df1dfc9cb1546691cc41f4e3130fe6bfbc3ecbbecfa", 69 | "sha256:2298c859cfc5463f1b64bd55cb3e602528db6fa0f3cfd568d3605c50678f8f03", 70 | "sha256:28057e985dace2f478e042eaa15606c7efccb700797660629da387eb289b9323", 71 | "sha256:2e7821bffe00aa6bd07a23913b7f4e01328c3d5cc0b40b36c0bd81d362faeb65", 72 | "sha256:2ec4f2d48ae59bbb9d1f9d7efb9236ab81429a764dedca114f5fdabbc3788013", 73 | "sha256:340bea174e9761308703ae988e982005aedf427de816d1afe98147668cc03036", 74 | "sha256:40627dcf047dadb22cd25ea7ecfe9cbf3bbbad0482ee5920b582f3809c97654f", 75 | "sha256:40dfd3fefbef579ee058f139733ac336312663c6706d1163b82b3003fb1925c4", 76 | "sha256:4cf06cdc1dda95223e9d2d3c58d3b178aa5dacb35ee7e3bbac10e4e1faacb419", 77 | "sha256:50c42830a633fa0cf9e7d27664637532791bfc31c731a87b202d2d8ac40c3ea2", 78 | "sha256:55f44b440d491028addb3b88f72207d71eeebfb7b5dbf0643f7c023ae1fba619", 79 | "sha256:608e7073dfa9e38a85d38474c082d4281f4ce276ac0010224eaba11e929dd53a", 80 | "sha256:63ba06c9941e46fa389d389644e2d8225e0e3e5ebcc4ff1ea8506dce646f8c8a", 81 | "sha256:65608c35bfb8a76763f37036547f7adfd09270fbdbf96608be2bead319728fcd", 82 | "sha256:665a36ae6f8f20a4676b53224e33d456a6f5a72657d9c83c2aa00765072f31f7", 83 | "sha256:6d6607f98fcf17e534162f0709aaad3ab7a96032723d8ac8750ffe17ae5a0666", 84 | "sha256:7313ce6a199651c4ed9d7e4cfb4aa56fe923b1adf9af3b420ee14e6d9a73df65", 85 | "sha256:7668b52e102d0ed87cb082380a7e2e1e78737ddecdde129acadb0eccc5423859", 86 | "sha256:7df70907e00c970c60b9ef2938d894a9381f38e6b9db73c5be35e59d92e06625", 87 | "sha256:7e007132af78ea9df29495dbf7b5824cb71648d7133cf7848a2a5dd00d36f9ff", 88 | "sha256:835fb5e38fd89328e9c81067fd642b3593c33e1e17e2fdbf77f5676abb14a156", 89 | "sha256:8bca7e26c1dd751236cfb0c6c72d4ad61d986e9a41bbf76cb445f69488b2a2bd", 90 | "sha256:8db032bf0ce9022a8e41a22598eefc802314e81b879ae093f36ce9ddf39ab1ba", 91 | "sha256:99625a92da8229df6d44335e6fcc558a5037dd0a760e11d84be2260e6f37002f", 92 | "sha256:9cad97ab29dfc3f0249b483412c85c8ef4766d96cdf9dcf5a1e3caa3f3661cf1", 93 | "sha256:a4abaec6ca3ad8660690236d11bfe28dfd707778e2442b45addd2f086d6ef094", 94 | "sha256:a6e40afa7f45939ca356f348c8e23048e02cb109ced1eb8420961b2f40fb373a", 95 | "sha256:a6f2fcca746e8d5910e18782f976489939d54a91f9411c32051b4aab2bd7c513", 96 | "sha256:a806db027852538d2ad7555b203300173dd1b77ba116de92da9afbc3a3be3eed", 97 | "sha256:abcabc8c2b26036d62d4c746381a6f7cf60aafcc653198ad678306986b09450d", 98 | "sha256:b8526c6d437855442cdd3d87eede9c425c4445ea011ca38d937db299382e6fa3", 99 | "sha256:bb06feb762bade6bf3c8b844462274db0c76acc95c52abe8dbed28ae3d44a147", 100 | "sha256:c0a33bc9f02c2b17c3ea382f91b4db0e6cde90b63b296422a939886a7a80de1c", 101 | "sha256:c4a549890a45f57f1ebf99c067a4ad0cb423a05544accaf2b065246827ed9603", 102 | "sha256:ca244fa73f50a800cf8c3ebf7fd93149ec37f5cb9596aa8873ae2c1d23498601", 103 | "sha256:cf877ab4ed6e302ec1d04952ca358b381a882fbd9d1b07cccbfd61783561f98a", 104 | "sha256:d9d971ec1e79906046aa3ca266de79eac42f1dbf3612a05dc9368125952bd1a1", 105 | "sha256:da25303d91526aac3672ee6d49a2f3db2d9502a4a60b55519feb1a4c7714e07d", 106 | "sha256:e55e40ff0cc8cc5c07996915ad367fa47da6b3fc091fdadca7f5403239c5fec3", 107 | "sha256:f03a532d7dee1bed20bc4884194a16160a2de9ffc6354b3878ec9682bb623c54", 108 | "sha256:f1cd098434e83e656abf198f103a8207a8187c0fc110306691a2e94a78d0abb2", 109 | "sha256:f2bfb563d0211ce16b63c7cb9395d2c682a23187f54c3d79bfec33e6705473c6", 110 | "sha256:f8ffb705ffcf5ddd0e80b65ddf7bed7ee4f5a441ea7d3419e861a12eaf41af58" 111 | ], 112 | "markers": "python_version >= '3.7'", 113 | "version": "==2.1.2" 114 | }, 115 | "mergedeep": { 116 | "hashes": [ 117 | "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8", 118 | "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307" 119 | ], 120 | "markers": "python_version >= '3.6'", 121 | "version": "==1.3.4" 122 | }, 123 | "mkdocs": { 124 | "hashes": [ 125 | "sha256:8947af423a6d0facf41ea1195b8e1e8c85ad94ac95ae307fe11232e0424b11c5", 126 | "sha256:c8856a832c1e56702577023cd64cc5f84948280c1c0fcc6af4cd39006ea6aa8c" 127 | ], 128 | "index": "pypi", 129 | "version": "==1.4.2" 130 | }, 131 | "packaging": { 132 | "hashes": [ 133 | "sha256:714ac14496c3e68c99c29b00845f7a2b85f3bb6f1078fd9f72fd20f0570002b2", 134 | "sha256:b6ad297f8907de0fa2fe1ccbd26fdaf387f5f47c7275fedf8cce89f99446cf97" 135 | ], 136 | "markers": "python_version >= '3.7'", 137 | "version": "==23.0" 138 | }, 139 | "python-dateutil": { 140 | "hashes": [ 141 | "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86", 142 | "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9" 143 | ], 144 | "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", 145 | "version": "==2.8.2" 146 | }, 147 | "pyyaml": { 148 | "hashes": [ 149 | "sha256:01b45c0191e6d66c470b6cf1b9531a771a83c1c4208272ead47a3ae4f2f603bf", 150 | "sha256:0283c35a6a9fbf047493e3a0ce8d79ef5030852c51e9d911a27badfde0605293", 151 | "sha256:055d937d65826939cb044fc8c9b08889e8c743fdc6a32b33e2390f66013e449b", 152 | "sha256:07751360502caac1c067a8132d150cf3d61339af5691fe9e87803040dbc5db57", 153 | "sha256:0b4624f379dab24d3725ffde76559cff63d9ec94e1736b556dacdfebe5ab6d4b", 154 | "sha256:0ce82d761c532fe4ec3f87fc45688bdd3a4c1dc5e0b4a19814b9009a29baefd4", 155 | "sha256:1e4747bc279b4f613a09eb64bba2ba602d8a6664c6ce6396a4d0cd413a50ce07", 156 | "sha256:213c60cd50106436cc818accf5baa1aba61c0189ff610f64f4a3e8c6726218ba", 157 | "sha256:231710d57adfd809ef5d34183b8ed1eeae3f76459c18fb4a0b373ad56bedcdd9", 158 | "sha256:277a0ef2981ca40581a47093e9e2d13b3f1fbbeffae064c1d21bfceba2030287", 159 | "sha256:2cd5df3de48857ed0544b34e2d40e9fac445930039f3cfe4bcc592a1f836d513", 160 | "sha256:40527857252b61eacd1d9af500c3337ba8deb8fc298940291486c465c8b46ec0", 161 | "sha256:432557aa2c09802be39460360ddffd48156e30721f5e8d917f01d31694216782", 162 | "sha256:473f9edb243cb1935ab5a084eb238d842fb8f404ed2193a915d1784b5a6b5fc0", 163 | "sha256:48c346915c114f5fdb3ead70312bd042a953a8ce5c7106d5bfb1a5254e47da92", 164 | "sha256:50602afada6d6cbfad699b0c7bb50d5ccffa7e46a3d738092afddc1f9758427f", 165 | "sha256:68fb519c14306fec9720a2a5b45bc9f0c8d1b9c72adf45c37baedfcd949c35a2", 166 | "sha256:77f396e6ef4c73fdc33a9157446466f1cff553d979bd00ecb64385760c6babdc", 167 | "sha256:81957921f441d50af23654aa6c5e5eaf9b06aba7f0a19c18a538dc7ef291c5a1", 168 | "sha256:819b3830a1543db06c4d4b865e70ded25be52a2e0631ccd2f6a47a2822f2fd7c", 169 | "sha256:897b80890765f037df3403d22bab41627ca8811ae55e9a722fd0392850ec4d86", 170 | "sha256:98c4d36e99714e55cfbaaee6dd5badbc9a1ec339ebfc3b1f52e293aee6bb71a4", 171 | "sha256:9df7ed3b3d2e0ecfe09e14741b857df43adb5a3ddadc919a2d94fbdf78fea53c", 172 | "sha256:9fa600030013c4de8165339db93d182b9431076eb98eb40ee068700c9c813e34", 173 | "sha256:a80a78046a72361de73f8f395f1f1e49f956c6be882eed58505a15f3e430962b", 174 | "sha256:afa17f5bc4d1b10afd4466fd3a44dc0e245382deca5b3c353d8b757f9e3ecb8d", 175 | "sha256:b3d267842bf12586ba6c734f89d1f5b871df0273157918b0ccefa29deb05c21c", 176 | "sha256:b5b9eccad747aabaaffbc6064800670f0c297e52c12754eb1d976c57e4f74dcb", 177 | "sha256:bfaef573a63ba8923503d27530362590ff4f576c626d86a9fed95822a8255fd7", 178 | "sha256:c5687b8d43cf58545ade1fe3e055f70eac7a5a1a0bf42824308d868289a95737", 179 | "sha256:cba8c411ef271aa037d7357a2bc8f9ee8b58b9965831d9e51baf703280dc73d3", 180 | "sha256:d15a181d1ecd0d4270dc32edb46f7cb7733c7c508857278d3d378d14d606db2d", 181 | "sha256:d4b0ba9512519522b118090257be113b9468d804b19d63c71dbcf4a48fa32358", 182 | "sha256:d4db7c7aef085872ef65a8fd7d6d09a14ae91f691dec3e87ee5ee0539d516f53", 183 | "sha256:d4eccecf9adf6fbcc6861a38015c2a64f38b9d94838ac1810a9023a0609e1b78", 184 | "sha256:d67d839ede4ed1b28a4e8909735fc992a923cdb84e618544973d7dfc71540803", 185 | "sha256:daf496c58a8c52083df09b80c860005194014c3698698d1a57cbcfa182142a3a", 186 | "sha256:dbad0e9d368bb989f4515da330b88a057617d16b6a8245084f1b05400f24609f", 187 | "sha256:e61ceaab6f49fb8bdfaa0f92c4b57bcfbea54c09277b1b4f7ac376bfb7a7c174", 188 | "sha256:f84fbc98b019fef2ee9a1cb3ce93e3187a6df0b2538a651bfb890254ba9f90b5" 189 | ], 190 | "markers": "python_version >= '3.6'", 191 | "version": "==6.0" 192 | }, 193 | "pyyaml-env-tag": { 194 | "hashes": [ 195 | "sha256:70092675bda14fdec33b31ba77e7543de9ddc88f2e5b99160396572d11525bdb", 196 | "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069" 197 | ], 198 | "markers": "python_version >= '3.6'", 199 | "version": "==0.1" 200 | }, 201 | "six": { 202 | "hashes": [ 203 | "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926", 204 | "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254" 205 | ], 206 | "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", 207 | "version": "==1.16.0" 208 | }, 209 | "soupsieve": { 210 | "hashes": [ 211 | "sha256:3b2503d3c7084a42b1ebd08116e5f81aadfaea95863628c80a3b774a11b7c759", 212 | "sha256:fc53893b3da2c33de295667a0e19f078c14bf86544af307354de5fcf12a3f30d" 213 | ], 214 | "markers": "python_version >= '3.6'", 215 | "version": "==2.3.2.post1" 216 | }, 217 | "watchdog": { 218 | "hashes": [ 219 | "sha256:102a60093090fc3ff76c983367b19849b7cc24ec414a43c0333680106e62aae1", 220 | "sha256:17f1708f7410af92ddf591e94ae71a27a13974559e72f7e9fde3ec174b26ba2e", 221 | "sha256:195ab1d9d611a4c1e5311cbf42273bc541e18ea8c32712f2fb703cfc6ff006f9", 222 | "sha256:4cb5ecc332112017fbdb19ede78d92e29a8165c46b68a0b8ccbd0a154f196d5e", 223 | "sha256:5100eae58133355d3ca6c1083a33b81355c4f452afa474c2633bd2fbbba398b3", 224 | "sha256:61fdb8e9c57baf625e27e1420e7ca17f7d2023929cd0065eb79c83da1dfbeacd", 225 | "sha256:6ccd8d84b9490a82b51b230740468116b8205822ea5fdc700a553d92661253a3", 226 | "sha256:6e01d699cd260d59b84da6bda019dce0a3353e3fcc774408ae767fe88ee096b7", 227 | "sha256:748ca797ff59962e83cc8e4b233f87113f3cf247c23e6be58b8a2885c7337aa3", 228 | "sha256:83a7cead445008e880dbde833cb9e5cc7b9a0958edb697a96b936621975f15b9", 229 | "sha256:8586d98c494690482c963ffb24c49bf9c8c2fe0589cec4dc2f753b78d1ec301d", 230 | "sha256:8b5cde14e5c72b2df5d074774bdff69e9b55da77e102a91f36ef26ca35f9819c", 231 | "sha256:8c28c23972ec9c524967895ccb1954bc6f6d4a557d36e681a36e84368660c4ce", 232 | "sha256:967636031fa4c4955f0f3f22da3c5c418aa65d50908d31b73b3b3ffd66d60640", 233 | "sha256:96cbeb494e6cbe3ae6aacc430e678ce4b4dd3ae5125035f72b6eb4e5e9eb4f4e", 234 | "sha256:978a1aed55de0b807913b7482d09943b23a2d634040b112bdf31811a422f6344", 235 | "sha256:a09483249d25cbdb4c268e020cb861c51baab2d1affd9a6affc68ffe6a231260", 236 | "sha256:a480d122740debf0afac4ddd583c6c0bb519c24f817b42ed6f850e2f6f9d64a8", 237 | "sha256:adaf2ece15f3afa33a6b45f76b333a7da9256e1360003032524d61bdb4c422ae", 238 | "sha256:bc43c1b24d2f86b6e1cc15f68635a959388219426109233e606517ff7d0a5a73", 239 | "sha256:c27d8c1535fd4474e40a4b5e01f4ba6720bac58e6751c667895cbc5c8a7af33c", 240 | "sha256:cdcc23c9528601a8a293eb4369cbd14f6b4f34f07ae8769421252e9c22718b6f", 241 | "sha256:cece1aa596027ff56369f0b50a9de209920e1df9ac6d02c7f9e5d8162eb4f02b", 242 | "sha256:d0f29fd9f3f149a5277929de33b4f121a04cf84bb494634707cfa8ea8ae106a8", 243 | "sha256:d6b87477752bd86ac5392ecb9eeed92b416898c30bd40c7e2dd03c3146105646", 244 | "sha256:e038be858425c4f621900b8ff1a3a1330d9edcfeaa1c0468aeb7e330fb87693e", 245 | "sha256:e618a4863726bc7a3c64f95c218437f3349fb9d909eb9ea3a1ed3b567417c661", 246 | "sha256:f8ac23ff2c2df4471a61af6490f847633024e5aa120567e08d07af5718c9d092" 247 | ], 248 | "markers": "python_version >= '3.6'", 249 | "version": "==2.2.1" 250 | } 251 | }, 252 | "develop": { 253 | "autopep8": { 254 | "hashes": [ 255 | "sha256:be5bc98c33515b67475420b7b1feafc8d32c1a69862498eda4983b45bffd2687", 256 | "sha256:d27a8929d8dcd21c0f4b3859d2d07c6c25273727b98afc984c039df0f0d86566" 257 | ], 258 | "index": "pypi", 259 | "version": "==2.0.1" 260 | }, 261 | "bleach": { 262 | "hashes": [ 263 | "sha256:085f7f33c15bd408dd9b17a4ad77c577db66d76203e5984b1bd59baeee948b2a", 264 | "sha256:0d03255c47eb9bd2f26aa9bb7f2107732e7e8fe195ca2f64709fcf3b0a4a085c" 265 | ], 266 | "markers": "python_version >= '3.7'", 267 | "version": "==5.0.1" 268 | }, 269 | "build": { 270 | "hashes": [ 271 | "sha256:af266720050a66c893a6096a2f410989eeac74ff9a68ba194b3f6473e8e26171", 272 | "sha256:d5b71264afdb5951d6704482aac78de887c80691c52b88a9ad195983ca2c9269" 273 | ], 274 | "index": "pypi", 275 | "version": "==0.10.0" 276 | }, 277 | "certifi": { 278 | "hashes": [ 279 | "sha256:35824b4c3a97115964b408844d64aa14db1cc518f6562e8d7261699d1350a9e3", 280 | "sha256:4ad3232f5e926d6718ec31cfc1fcadfde020920e278684144551c91769c7bc18" 281 | ], 282 | "markers": "python_version >= '3.6'", 283 | "version": "==2022.12.7" 284 | }, 285 | "cffi": { 286 | "hashes": [ 287 | "sha256:00a9ed42e88df81ffae7a8ab6d9356b371399b91dbdf0c3cb1e84c03a13aceb5", 288 | "sha256:03425bdae262c76aad70202debd780501fabeaca237cdfddc008987c0e0f59ef", 289 | "sha256:04ed324bda3cda42b9b695d51bb7d54b680b9719cfab04227cdd1e04e5de3104", 290 | "sha256:0e2642fe3142e4cc4af0799748233ad6da94c62a8bec3a6648bf8ee68b1c7426", 291 | "sha256:173379135477dc8cac4bc58f45db08ab45d228b3363adb7af79436135d028405", 292 | "sha256:198caafb44239b60e252492445da556afafc7d1e3ab7a1fb3f0584ef6d742375", 293 | "sha256:1e74c6b51a9ed6589199c787bf5f9875612ca4a8a0785fb2d4a84429badaf22a", 294 | "sha256:2012c72d854c2d03e45d06ae57f40d78e5770d252f195b93f581acf3ba44496e", 295 | "sha256:21157295583fe8943475029ed5abdcf71eb3911894724e360acff1d61c1d54bc", 296 | "sha256:2470043b93ff09bf8fb1d46d1cb756ce6132c54826661a32d4e4d132e1977adf", 297 | "sha256:285d29981935eb726a4399badae8f0ffdff4f5050eaa6d0cfc3f64b857b77185", 298 | "sha256:30d78fbc8ebf9c92c9b7823ee18eb92f2e6ef79b45ac84db507f52fbe3ec4497", 299 | "sha256:320dab6e7cb2eacdf0e658569d2575c4dad258c0fcc794f46215e1e39f90f2c3", 300 | "sha256:33ab79603146aace82c2427da5ca6e58f2b3f2fb5da893ceac0c42218a40be35", 301 | "sha256:3548db281cd7d2561c9ad9984681c95f7b0e38881201e157833a2342c30d5e8c", 302 | "sha256:3799aecf2e17cf585d977b780ce79ff0dc9b78d799fc694221ce814c2c19db83", 303 | "sha256:39d39875251ca8f612b6f33e6b1195af86d1b3e60086068be9cc053aa4376e21", 304 | "sha256:3b926aa83d1edb5aa5b427b4053dc420ec295a08e40911296b9eb1b6170f6cca", 305 | "sha256:3bcde07039e586f91b45c88f8583ea7cf7a0770df3a1649627bf598332cb6984", 306 | "sha256:3d08afd128ddaa624a48cf2b859afef385b720bb4b43df214f85616922e6a5ac", 307 | "sha256:3eb6971dcff08619f8d91607cfc726518b6fa2a9eba42856be181c6d0d9515fd", 308 | "sha256:40f4774f5a9d4f5e344f31a32b5096977b5d48560c5592e2f3d2c4374bd543ee", 309 | "sha256:4289fc34b2f5316fbb762d75362931e351941fa95fa18789191b33fc4cf9504a", 310 | "sha256:470c103ae716238bbe698d67ad020e1db9d9dba34fa5a899b5e21577e6d52ed2", 311 | "sha256:4f2c9f67e9821cad2e5f480bc8d83b8742896f1242dba247911072d4fa94c192", 312 | "sha256:50a74364d85fd319352182ef59c5c790484a336f6db772c1a9231f1c3ed0cbd7", 313 | "sha256:54a2db7b78338edd780e7ef7f9f6c442500fb0d41a5a4ea24fff1c929d5af585", 314 | "sha256:5635bd9cb9731e6d4a1132a498dd34f764034a8ce60cef4f5319c0541159392f", 315 | "sha256:59c0b02d0a6c384d453fece7566d1c7e6b7bae4fc5874ef2ef46d56776d61c9e", 316 | "sha256:5d598b938678ebf3c67377cdd45e09d431369c3b1a5b331058c338e201f12b27", 317 | "sha256:5df2768244d19ab7f60546d0c7c63ce1581f7af8b5de3eb3004b9b6fc8a9f84b", 318 | "sha256:5ef34d190326c3b1f822a5b7a45f6c4535e2f47ed06fec77d3d799c450b2651e", 319 | "sha256:6975a3fac6bc83c4a65c9f9fcab9e47019a11d3d2cf7f3c0d03431bf145a941e", 320 | "sha256:6c9a799e985904922a4d207a94eae35c78ebae90e128f0c4e521ce339396be9d", 321 | "sha256:70df4e3b545a17496c9b3f41f5115e69a4f2e77e94e1d2a8e1070bc0c38c8a3c", 322 | "sha256:7473e861101c9e72452f9bf8acb984947aa1661a7704553a9f6e4baa5ba64415", 323 | "sha256:8102eaf27e1e448db915d08afa8b41d6c7ca7a04b7d73af6514df10a3e74bd82", 324 | "sha256:87c450779d0914f2861b8526e035c5e6da0a3199d8f1add1a665e1cbc6fc6d02", 325 | "sha256:8b7ee99e510d7b66cdb6c593f21c043c248537a32e0bedf02e01e9553a172314", 326 | "sha256:91fc98adde3d7881af9b59ed0294046f3806221863722ba7d8d120c575314325", 327 | "sha256:94411f22c3985acaec6f83c6df553f2dbe17b698cc7f8ae751ff2237d96b9e3c", 328 | "sha256:98d85c6a2bef81588d9227dde12db8a7f47f639f4a17c9ae08e773aa9c697bf3", 329 | "sha256:9ad5db27f9cabae298d151c85cf2bad1d359a1b9c686a275df03385758e2f914", 330 | "sha256:a0b71b1b8fbf2b96e41c4d990244165e2c9be83d54962a9a1d118fd8657d2045", 331 | "sha256:a0f100c8912c114ff53e1202d0078b425bee3649ae34d7b070e9697f93c5d52d", 332 | "sha256:a591fe9e525846e4d154205572a029f653ada1a78b93697f3b5a8f1f2bc055b9", 333 | "sha256:a5c84c68147988265e60416b57fc83425a78058853509c1b0629c180094904a5", 334 | "sha256:a66d3508133af6e8548451b25058d5812812ec3798c886bf38ed24a98216fab2", 335 | "sha256:a8c4917bd7ad33e8eb21e9a5bbba979b49d9a97acb3a803092cbc1133e20343c", 336 | "sha256:b3bbeb01c2b273cca1e1e0c5df57f12dce9a4dd331b4fa1635b8bec26350bde3", 337 | "sha256:cba9d6b9a7d64d4bd46167096fc9d2f835e25d7e4c121fb2ddfc6528fb0413b2", 338 | "sha256:cc4d65aeeaa04136a12677d3dd0b1c0c94dc43abac5860ab33cceb42b801c1e8", 339 | "sha256:ce4bcc037df4fc5e3d184794f27bdaab018943698f4ca31630bc7f84a7b69c6d", 340 | "sha256:cec7d9412a9102bdc577382c3929b337320c4c4c4849f2c5cdd14d7368c5562d", 341 | "sha256:d400bfb9a37b1351253cb402671cea7e89bdecc294e8016a707f6d1d8ac934f9", 342 | "sha256:d61f4695e6c866a23a21acab0509af1cdfd2c013cf256bbf5b6b5e2695827162", 343 | "sha256:db0fbb9c62743ce59a9ff687eb5f4afbe77e5e8403d6697f7446e5f609976f76", 344 | "sha256:dd86c085fae2efd48ac91dd7ccffcfc0571387fe1193d33b6394db7ef31fe2a4", 345 | "sha256:e00b098126fd45523dd056d2efba6c5a63b71ffe9f2bbe1a4fe1716e1d0c331e", 346 | "sha256:e229a521186c75c8ad9490854fd8bbdd9a0c9aa3a524326b55be83b54d4e0ad9", 347 | "sha256:e263d77ee3dd201c3a142934a086a4450861778baaeeb45db4591ef65550b0a6", 348 | "sha256:ed9cb427ba5504c1dc15ede7d516b84757c3e3d7868ccc85121d9310d27eed0b", 349 | "sha256:fa6693661a4c91757f4412306191b6dc88c1703f780c8234035eac011922bc01", 350 | "sha256:fcd131dd944808b5bdb38e6f5b53013c5aa4f334c5cad0c72742f6eba4b73db0" 351 | ], 352 | "version": "==1.15.1" 353 | }, 354 | "charset-normalizer": { 355 | "hashes": [ 356 | "sha256:00d3ffdaafe92a5dc603cb9bd5111aaa36dfa187c8285c543be562e61b755f6b", 357 | "sha256:024e606be3ed92216e2b6952ed859d86b4cfa52cd5bc5f050e7dc28f9b43ec42", 358 | "sha256:0298eafff88c99982a4cf66ba2efa1128e4ddaca0b05eec4c456bbc7db691d8d", 359 | "sha256:02a51034802cbf38db3f89c66fb5d2ec57e6fe7ef2f4a44d070a593c3688667b", 360 | "sha256:083c8d17153ecb403e5e1eb76a7ef4babfc2c48d58899c98fcaa04833e7a2f9a", 361 | "sha256:0a11e971ed097d24c534c037d298ad32c6ce81a45736d31e0ff0ad37ab437d59", 362 | "sha256:0bf2dae5291758b6f84cf923bfaa285632816007db0330002fa1de38bfcb7154", 363 | "sha256:0c0a590235ccd933d9892c627dec5bc7511ce6ad6c1011fdf5b11363022746c1", 364 | "sha256:0f438ae3532723fb6ead77e7c604be7c8374094ef4ee2c5e03a3a17f1fca256c", 365 | "sha256:109487860ef6a328f3eec66f2bf78b0b72400280d8f8ea05f69c51644ba6521a", 366 | "sha256:11b53acf2411c3b09e6af37e4b9005cba376c872503c8f28218c7243582df45d", 367 | "sha256:12db3b2c533c23ab812c2b25934f60383361f8a376ae272665f8e48b88e8e1c6", 368 | "sha256:14e76c0f23218b8f46c4d87018ca2e441535aed3632ca134b10239dfb6dadd6b", 369 | "sha256:16a8663d6e281208d78806dbe14ee9903715361cf81f6d4309944e4d1e59ac5b", 370 | "sha256:292d5e8ba896bbfd6334b096e34bffb56161c81408d6d036a7dfa6929cff8783", 371 | "sha256:2c03cc56021a4bd59be889c2b9257dae13bf55041a3372d3295416f86b295fb5", 372 | "sha256:2e396d70bc4ef5325b72b593a72c8979999aa52fb8bcf03f701c1b03e1166918", 373 | "sha256:2edb64ee7bf1ed524a1da60cdcd2e1f6e2b4f66ef7c077680739f1641f62f555", 374 | "sha256:31a9ddf4718d10ae04d9b18801bd776693487cbb57d74cc3458a7673f6f34639", 375 | "sha256:356541bf4381fa35856dafa6a965916e54bed415ad8a24ee6de6e37deccf2786", 376 | "sha256:358a7c4cb8ba9b46c453b1dd8d9e431452d5249072e4f56cfda3149f6ab1405e", 377 | "sha256:37f8febc8ec50c14f3ec9637505f28e58d4f66752207ea177c1d67df25da5aed", 378 | "sha256:39049da0ffb96c8cbb65cbf5c5f3ca3168990adf3551bd1dee10c48fce8ae820", 379 | "sha256:39cf9ed17fe3b1bc81f33c9ceb6ce67683ee7526e65fde1447c772afc54a1bb8", 380 | "sha256:3ae1de54a77dc0d6d5fcf623290af4266412a7c4be0b1ff7444394f03f5c54e3", 381 | "sha256:3b590df687e3c5ee0deef9fc8c547d81986d9a1b56073d82de008744452d6541", 382 | "sha256:3e45867f1f2ab0711d60c6c71746ac53537f1684baa699f4f668d4c6f6ce8e14", 383 | "sha256:3fc1c4a2ffd64890aebdb3f97e1278b0cc72579a08ca4de8cd2c04799a3a22be", 384 | "sha256:4457ea6774b5611f4bed5eaa5df55f70abde42364d498c5134b7ef4c6958e20e", 385 | "sha256:44ba614de5361b3e5278e1241fda3dc1838deed864b50a10d7ce92983797fa76", 386 | "sha256:4a8fcf28c05c1f6d7e177a9a46a1c52798bfe2ad80681d275b10dcf317deaf0b", 387 | "sha256:4b0d02d7102dd0f997580b51edc4cebcf2ab6397a7edf89f1c73b586c614272c", 388 | "sha256:502218f52498a36d6bf5ea77081844017bf7982cdbe521ad85e64cabee1b608b", 389 | "sha256:503e65837c71b875ecdd733877d852adbc465bd82c768a067badd953bf1bc5a3", 390 | "sha256:5995f0164fa7df59db4746112fec3f49c461dd6b31b841873443bdb077c13cfc", 391 | "sha256:59e5686dd847347e55dffcc191a96622f016bc0ad89105e24c14e0d6305acbc6", 392 | "sha256:601f36512f9e28f029d9481bdaf8e89e5148ac5d89cffd3b05cd533eeb423b59", 393 | "sha256:608862a7bf6957f2333fc54ab4399e405baad0163dc9f8d99cb236816db169d4", 394 | "sha256:62595ab75873d50d57323a91dd03e6966eb79c41fa834b7a1661ed043b2d404d", 395 | "sha256:70990b9c51340e4044cfc394a81f614f3f90d41397104d226f21e66de668730d", 396 | "sha256:71140351489970dfe5e60fc621ada3e0f41104a5eddaca47a7acb3c1b851d6d3", 397 | "sha256:72966d1b297c741541ca8cf1223ff262a6febe52481af742036a0b296e35fa5a", 398 | "sha256:74292fc76c905c0ef095fe11e188a32ebd03bc38f3f3e9bcb85e4e6db177b7ea", 399 | "sha256:761e8904c07ad053d285670f36dd94e1b6ab7f16ce62b9805c475b7aa1cffde6", 400 | "sha256:772b87914ff1152b92a197ef4ea40efe27a378606c39446ded52c8f80f79702e", 401 | "sha256:79909e27e8e4fcc9db4addea88aa63f6423ebb171db091fb4373e3312cb6d603", 402 | "sha256:7e189e2e1d3ed2f4aebabd2d5b0f931e883676e51c7624826e0a4e5fe8a0bf24", 403 | "sha256:7eb33a30d75562222b64f569c642ff3dc6689e09adda43a082208397f016c39a", 404 | "sha256:81d6741ab457d14fdedc215516665050f3822d3e56508921cc7239f8c8e66a58", 405 | "sha256:8499ca8f4502af841f68135133d8258f7b32a53a1d594aa98cc52013fff55678", 406 | "sha256:84c3990934bae40ea69a82034912ffe5a62c60bbf6ec5bc9691419641d7d5c9a", 407 | "sha256:87701167f2a5c930b403e9756fab1d31d4d4da52856143b609e30a1ce7160f3c", 408 | "sha256:88600c72ef7587fe1708fd242b385b6ed4b8904976d5da0893e31df8b3480cb6", 409 | "sha256:8ac7b6a045b814cf0c47f3623d21ebd88b3e8cf216a14790b455ea7ff0135d18", 410 | "sha256:8b8af03d2e37866d023ad0ddea594edefc31e827fee64f8de5611a1dbc373174", 411 | "sha256:8c7fe7afa480e3e82eed58e0ca89f751cd14d767638e2550c77a92a9e749c317", 412 | "sha256:8eade758719add78ec36dc13201483f8e9b5d940329285edcd5f70c0a9edbd7f", 413 | "sha256:911d8a40b2bef5b8bbae2e36a0b103f142ac53557ab421dc16ac4aafee6f53dc", 414 | "sha256:93ad6d87ac18e2a90b0fe89df7c65263b9a99a0eb98f0a3d2e079f12a0735837", 415 | "sha256:95dea361dd73757c6f1c0a1480ac499952c16ac83f7f5f4f84f0658a01b8ef41", 416 | "sha256:9ab77acb98eba3fd2a85cd160851816bfce6871d944d885febf012713f06659c", 417 | "sha256:9cb3032517f1627cc012dbc80a8ec976ae76d93ea2b5feaa9d2a5b8882597579", 418 | "sha256:9cf4e8ad252f7c38dd1f676b46514f92dc0ebeb0db5552f5f403509705e24753", 419 | "sha256:9d9153257a3f70d5f69edf2325357251ed20f772b12e593f3b3377b5f78e7ef8", 420 | "sha256:a152f5f33d64a6be73f1d30c9cc82dfc73cec6477ec268e7c6e4c7d23c2d2291", 421 | "sha256:a16418ecf1329f71df119e8a65f3aa68004a3f9383821edcb20f0702934d8087", 422 | "sha256:a60332922359f920193b1d4826953c507a877b523b2395ad7bc716ddd386d866", 423 | "sha256:a8d0fc946c784ff7f7c3742310cc8a57c5c6dc31631269876a88b809dbeff3d3", 424 | "sha256:ab5de034a886f616a5668aa5d098af2b5385ed70142090e2a31bcbd0af0fdb3d", 425 | "sha256:c22d3fe05ce11d3671297dc8973267daa0f938b93ec716e12e0f6dee81591dc1", 426 | "sha256:c2ac1b08635a8cd4e0cbeaf6f5e922085908d48eb05d44c5ae9eabab148512ca", 427 | "sha256:c512accbd6ff0270939b9ac214b84fb5ada5f0409c44298361b2f5e13f9aed9e", 428 | "sha256:c75ffc45f25324e68ab238cb4b5c0a38cd1c3d7f1fb1f72b5541de469e2247db", 429 | "sha256:c95a03c79bbe30eec3ec2b7f076074f4281526724c8685a42872974ef4d36b72", 430 | "sha256:cadaeaba78750d58d3cc6ac4d1fd867da6fc73c88156b7a3212a3cd4819d679d", 431 | "sha256:cd6056167405314a4dc3c173943f11249fa0f1b204f8b51ed4bde1a9cd1834dc", 432 | "sha256:db72b07027db150f468fbada4d85b3b2729a3db39178abf5c543b784c1254539", 433 | "sha256:df2c707231459e8a4028eabcd3cfc827befd635b3ef72eada84ab13b52e1574d", 434 | "sha256:e62164b50f84e20601c1ff8eb55620d2ad25fb81b59e3cd776a1902527a788af", 435 | "sha256:e696f0dd336161fca9adbb846875d40752e6eba585843c768935ba5c9960722b", 436 | "sha256:eaa379fcd227ca235d04152ca6704c7cb55564116f8bc52545ff357628e10602", 437 | "sha256:ebea339af930f8ca5d7a699b921106c6e29c617fe9606fa7baa043c1cdae326f", 438 | "sha256:f4c39b0e3eac288fedc2b43055cfc2ca7a60362d0e5e87a637beac5d801ef478", 439 | "sha256:f5057856d21e7586765171eac8b9fc3f7d44ef39425f85dbcccb13b3ebea806c", 440 | "sha256:f6f45710b4459401609ebebdbcfb34515da4fc2aa886f95107f556ac69a9147e", 441 | "sha256:f97e83fa6c25693c7a35de154681fcc257c1c41b38beb0304b9c4d2d9e164479", 442 | "sha256:f9d0c5c045a3ca9bedfc35dca8526798eb91a07aa7a2c0fee134c6c6f321cbd7", 443 | "sha256:ff6f3db31555657f3163b15a6b7c6938d08df7adbfc9dd13d9d19edad678f1e8" 444 | ], 445 | "version": "==3.0.1" 446 | }, 447 | "cryptography": { 448 | "hashes": [ 449 | "sha256:1a6915075c6d3a5e1215eab5d99bcec0da26036ff2102a1038401d6ef5bef25b", 450 | "sha256:1ee1fd0de9851ff32dbbb9362a4d833b579b4a6cc96883e8e6d2ff2a6bc7104f", 451 | "sha256:407cec680e811b4fc829de966f88a7c62a596faa250fc1a4b520a0355b9bc190", 452 | "sha256:50386acb40fbabbceeb2986332f0287f50f29ccf1497bae31cf5c3e7b4f4b34f", 453 | "sha256:6f97109336df5c178ee7c9c711b264c502b905c2d2a29ace99ed761533a3460f", 454 | "sha256:754978da4d0457e7ca176f58c57b1f9de6556591c19b25b8bcce3c77d314f5eb", 455 | "sha256:76c24dd4fd196a80f9f2f5405a778a8ca132f16b10af113474005635fe7e066c", 456 | "sha256:7dacfdeee048814563eaaec7c4743c8aea529fe3dd53127313a792f0dadc1773", 457 | "sha256:80ee674c08aaef194bc4627b7f2956e5ba7ef29c3cc3ca488cf15854838a8f72", 458 | "sha256:844ad4d7c3850081dffba91cdd91950038ee4ac525c575509a42d3fc806b83c8", 459 | "sha256:875aea1039d78557c7c6b4db2fe0e9d2413439f4676310a5f269dd342ca7a717", 460 | "sha256:887cbc1ea60786e534b00ba8b04d1095f4272d380ebd5f7a7eb4cc274710fad9", 461 | "sha256:ad04f413436b0781f20c52a661660f1e23bcd89a0e9bb1d6d20822d048cf2856", 462 | "sha256:bae6c7f4a36a25291b619ad064a30a07110a805d08dc89984f4f441f6c1f3f96", 463 | "sha256:c52a1a6f81e738d07f43dab57831c29e57d21c81a942f4602fac7ee21b27f288", 464 | "sha256:e0a05aee6a82d944f9b4edd6a001178787d1546ec7c6223ee9a848a7ade92e39", 465 | "sha256:e324de6972b151f99dc078defe8fb1b0a82c6498e37bff335f5bc6b1e3ab5a1e", 466 | "sha256:e5d71c5d5bd5b5c3eebcf7c5c2bb332d62ec68921a8c593bea8c394911a005ce", 467 | "sha256:f3ed2d864a2fa1666e749fe52fb8e23d8e06b8012e8bd8147c73797c506e86f1", 468 | "sha256:f671c1bb0d6088e94d61d80c606d65baacc0d374e67bf895148883461cd848de", 469 | "sha256:f6c0db08d81ead9576c4d94bbb27aed8d7a430fa27890f39084c2d0e2ec6b0df", 470 | "sha256:f964c7dcf7802d133e8dbd1565914fa0194f9d683d82411989889ecd701e8adf", 471 | "sha256:fec8b932f51ae245121c4671b4bbc030880f363354b2f0e0bd1366017d891458" 472 | ], 473 | "markers": "python_version >= '3.6'", 474 | "version": "==39.0.0" 475 | }, 476 | "docutils": { 477 | "hashes": [ 478 | "sha256:33995a6753c30b7f577febfc2c50411fec6aac7f7ffeb7c4cfe5991072dcf9e6", 479 | "sha256:5e1de4d849fee02c63b040a4a3fd567f4ab104defd8a5511fbbc24a8a017efbc" 480 | ], 481 | "markers": "python_version >= '3.7'", 482 | "version": "==0.19" 483 | }, 484 | "idna": { 485 | "hashes": [ 486 | "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4", 487 | "sha256:90b77e79eaa3eba6de819a0c442c0b4ceefc341a7a2ab77d7562bf49f425c5c2" 488 | ], 489 | "markers": "python_version >= '3.5'", 490 | "version": "==3.4" 491 | }, 492 | "importlib-metadata": { 493 | "hashes": [ 494 | "sha256:7efb448ec9a5e313a57655d35aa54cd3e01b7e1fbcf72dce1bf06119420f5bad", 495 | "sha256:e354bedeb60efa6affdcc8ae121b73544a7aa74156d047311948f6d711cd378d" 496 | ], 497 | "markers": "python_version >= '3.7'", 498 | "version": "==6.0.0" 499 | }, 500 | "jaraco.classes": { 501 | "hashes": [ 502 | "sha256:2353de3288bc6b82120752201c6b1c1a14b058267fa424ed5ce5984e3b922158", 503 | "sha256:89559fa5c1d3c34eff6f631ad80bb21f378dbcbb35dd161fd2c6b93f5be2f98a" 504 | ], 505 | "markers": "python_version >= '3.7'", 506 | "version": "==3.2.3" 507 | }, 508 | "jeepney": { 509 | "hashes": [ 510 | "sha256:5efe48d255973902f6badc3ce55e2aa6c5c3b3bc642059ef3a91247bcfcc5806", 511 | "sha256:c0a454ad016ca575060802ee4d590dd912e35c122fa04e70306de3d076cce755" 512 | ], 513 | "markers": "sys_platform == 'linux'", 514 | "version": "==0.8.0" 515 | }, 516 | "keyring": { 517 | "hashes": [ 518 | "sha256:771ed2a91909389ed6148631de678f82ddc73737d85a927f382a8a1b157898cd", 519 | "sha256:ba2e15a9b35e21908d0aaf4e0a47acc52d6ae33444df0da2b49d41a46ef6d678" 520 | ], 521 | "markers": "python_version >= '3.7'", 522 | "version": "==23.13.1" 523 | }, 524 | "markdown-it-py": { 525 | "hashes": [ 526 | "sha256:93de681e5c021a432c63147656fe21790bc01231e0cd2da73626f1aa3ac0fe27", 527 | "sha256:cf7e59fed14b5ae17c0006eff14a2d9a00ed5f3a846148153899a0224e2c07da" 528 | ], 529 | "markers": "python_version >= '3.7'", 530 | "version": "==2.1.0" 531 | }, 532 | "mdurl": { 533 | "hashes": [ 534 | "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", 535 | "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba" 536 | ], 537 | "markers": "python_version >= '3.7'", 538 | "version": "==0.1.2" 539 | }, 540 | "more-itertools": { 541 | "hashes": [ 542 | "sha256:250e83d7e81d0c87ca6bd942e6aeab8cc9daa6096d12c5308f3f92fa5e5c1f41", 543 | "sha256:5a6257e40878ef0520b1803990e3e22303a41b5714006c32a3fd8304b26ea1ab" 544 | ], 545 | "markers": "python_version >= '3.7'", 546 | "version": "==9.0.0" 547 | }, 548 | "packaging": { 549 | "hashes": [ 550 | "sha256:714ac14496c3e68c99c29b00845f7a2b85f3bb6f1078fd9f72fd20f0570002b2", 551 | "sha256:b6ad297f8907de0fa2fe1ccbd26fdaf387f5f47c7275fedf8cce89f99446cf97" 552 | ], 553 | "markers": "python_version >= '3.7'", 554 | "version": "==23.0" 555 | }, 556 | "pkginfo": { 557 | "hashes": [ 558 | "sha256:4b7a555a6d5a22169fcc9cf7bfd78d296b0361adad412a346c1226849af5e546", 559 | "sha256:8fd5896e8718a4372f0ea9cc9d96f6417c9b986e23a4d116dda26b62cc29d046" 560 | ], 561 | "markers": "python_version >= '3.6'", 562 | "version": "==1.9.6" 563 | }, 564 | "pycodestyle": { 565 | "hashes": [ 566 | "sha256:347187bdb476329d98f695c213d7295a846d1152ff4fe9bacb8a9590b8ee7053", 567 | "sha256:8a4eaf0d0495c7395bdab3589ac2db602797d76207242c17d470186815706610" 568 | ], 569 | "markers": "python_version >= '3.6'", 570 | "version": "==2.10.0" 571 | }, 572 | "pycparser": { 573 | "hashes": [ 574 | "sha256:8ee45429555515e1f6b185e78100aea234072576aa43ab53aefcae078162fca9", 575 | "sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206" 576 | ], 577 | "version": "==2.21" 578 | }, 579 | "pygments": { 580 | "hashes": [ 581 | "sha256:b3ed06a9e8ac9a9aae5a6f5dbe78a8a58655d17b43b93c078f094ddc476ae297", 582 | "sha256:fa7bd7bd2771287c0de303af8bfdfc731f51bd2c6a47ab69d117138893b82717" 583 | ], 584 | "markers": "python_version >= '3.6'", 585 | "version": "==2.14.0" 586 | }, 587 | "pyproject-hooks": { 588 | "hashes": [ 589 | "sha256:283c11acd6b928d2f6a7c73fa0d01cb2bdc5f07c57a2eeb6e83d5e56b97976f8", 590 | "sha256:f271b298b97f5955d53fb12b72c1fb1948c22c1a6b70b315c54cedaca0264ef5" 591 | ], 592 | "markers": "python_version >= '3.7'", 593 | "version": "==1.0.0" 594 | }, 595 | "readme-renderer": { 596 | "hashes": [ 597 | "sha256:cd653186dfc73055656f090f227f5cb22a046d7f71a841dfa305f55c9a513273", 598 | "sha256:f67a16caedfa71eef48a31b39708637a6f4664c4394801a7b0d6432d13907343" 599 | ], 600 | "markers": "python_version >= '3.7'", 601 | "version": "==37.3" 602 | }, 603 | "requests": { 604 | "hashes": [ 605 | "sha256:64299f4909223da747622c030b781c0d7811e359c37124b4bd368fb8c6518baa", 606 | "sha256:98b1b2782e3c6c4904938b84c0eb932721069dfdb9134313beff7c83c2df24bf" 607 | ], 608 | "markers": "python_version >= '3.7' and python_version < '4'", 609 | "version": "==2.28.2" 610 | }, 611 | "requests-toolbelt": { 612 | "hashes": [ 613 | "sha256:18565aa58116d9951ac39baa288d3adb5b3ff975c4f25eee78555d89e8f247f7", 614 | "sha256:62e09f7ff5ccbda92772a29f394a49c3ad6cb181d568b1337626b2abb628a63d" 615 | ], 616 | "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", 617 | "version": "==0.10.1" 618 | }, 619 | "rfc3986": { 620 | "hashes": [ 621 | "sha256:50b1502b60e289cb37883f3dfd34532b8873c7de9f49bb546641ce9cbd256ebd", 622 | "sha256:97aacf9dbd4bfd829baad6e6309fa6573aaf1be3f6fa735c8ab05e46cecb261c" 623 | ], 624 | "markers": "python_version >= '3.7'", 625 | "version": "==2.0.0" 626 | }, 627 | "rich": { 628 | "hashes": [ 629 | "sha256:7c963f0d03819221e9ac561e1bc866e3f95a02248c1234daa48954e6d381c003", 630 | "sha256:f1a00cdd3eebf999a15d85ec498bfe0b1a77efe9b34f645768a54132ef444ac5" 631 | ], 632 | "markers": "python_full_version >= '3.7.0'", 633 | "version": "==13.2.0" 634 | }, 635 | "secretstorage": { 636 | "hashes": [ 637 | "sha256:2403533ef369eca6d2ba81718576c5e0f564d5cca1b58f73a8b23e7d4eeebd77", 638 | "sha256:f356e6628222568e3af06f2eba8df495efa13b3b63081dafd4f7d9a7b7bc9f99" 639 | ], 640 | "markers": "sys_platform == 'linux'", 641 | "version": "==3.3.3" 642 | }, 643 | "six": { 644 | "hashes": [ 645 | "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926", 646 | "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254" 647 | ], 648 | "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", 649 | "version": "==1.16.0" 650 | }, 651 | "tomli": { 652 | "hashes": [ 653 | "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc", 654 | "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f" 655 | ], 656 | "markers": "python_version < '3.11'", 657 | "version": "==2.0.1" 658 | }, 659 | "twine": { 660 | "hashes": [ 661 | "sha256:929bc3c280033347a00f847236564d1c52a3e61b1ac2516c97c48f3ceab756d8", 662 | "sha256:9e102ef5fdd5a20661eb88fad46338806c3bd32cf1db729603fe3697b1bc83c8" 663 | ], 664 | "index": "pypi", 665 | "version": "==4.0.2" 666 | }, 667 | "urllib3": { 668 | "hashes": [ 669 | "sha256:076907bf8fd355cde77728471316625a4d2f7e713c125f51953bb5b3eecf4f72", 670 | "sha256:75edcdc2f7d85b137124a6c3c9fc3933cdeaa12ecb9a6a959f22797a0feca7e1" 671 | ], 672 | "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'", 673 | "version": "==1.26.14" 674 | }, 675 | "webencodings": { 676 | "hashes": [ 677 | "sha256:a0af1213f3c2226497a97e2b3aa01a7e4bee4f403f95be16fc9acd2947514a78", 678 | "sha256:b36a1c245f2d304965eb4e0a82848379241dc04b865afcc4aab16748587e1923" 679 | ], 680 | "version": "==0.5.1" 681 | }, 682 | "zipp": { 683 | "hashes": [ 684 | "sha256:83a28fcb75844b5c0cdaf5aa4003c2d728c77e05f5aeabe8e95e56727005fbaa", 685 | "sha256:a7a22e05929290a67401440b39690ae6563279bced5f314609d9d03798f56766" 686 | ], 687 | "markers": "python_version >= '3.7'", 688 | "version": "==3.11.0" 689 | } 690 | } 691 | } 692 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mkdocs-backlinks 2 | 3 | This is a plugin for adding backlinks to your mkdocs generated pages. 4 | 5 | Mkdocs is an awesome tool not only for documentation, but also for publishing [digital gardens](https://danodic.dev). 6 | Backlinks are a desirable component when building such digital gardens, as they enable the ability to explore content 7 | based on how the knowledge interconnects instead of just looking at page navigation. 8 | 9 | ## Setup 10 | 11 | Install the plugin using pip: 12 | 13 | `pip install mkdocs-backlinks` 14 | 15 | Activate the plugin in `mkdocs.yml`: 16 | 17 | ```yaml 18 | plugins: 19 | - mkdocs-backlinks 20 | ``` 21 | 22 | > **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. 23 | > MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly. 24 | 25 | More information about plugins in the [MkDocs documentation][mkdocs-plugins]. 26 | 27 | ## Config 28 | 29 | * `ignored_pages` - A list of page titles that will be excluded from the backlinks. 30 | 31 | ```yaml 32 | plugins: 33 | - mkdocs-backlinks: 34 | ignored_pages: [ 'Tags', 'Home' ] 35 | ``` 36 | 37 | ## Usage 38 | 39 | This plugin will add a `backlinks` attribute to the Jinja page context, which can be used to add backlinks at any point 40 | in your template. Here is an example of it: 41 | 42 | ```html 43 | ... 44 | 45 | {% if backlinks %} 46 |

Backlinks:

47 | 52 | {% endif %} 53 | 54 | ... 55 | ``` 56 | 57 | That means **you need to have a template that supports backlinks**, or you can alter the template you are using with the 58 | snippet above. 59 | 60 | ### Writing Notes 61 | 62 | I have been using this to publish my Obsidian vault, and there are some _tricks_ to make it work well: 63 | 64 | - Obsidian is smart and will resolve links even if they don´t refer to a valid file path. This is not 65 | true for mkdocs and the backlinks plugin -- you need to write valid links in your markdown files, either 66 | absolute or relative links. 67 | - Absolute links are absolute related to the root of the `/docs` folder, not to your computer filesystem. 68 | 69 | Following those two rules will allow you to go straight from obsidian to mkdocs with cool backlinks. 70 | 71 | ## See Also 72 | 73 | More information about templates [here][mkdocs-template]. 74 | 75 | More information about blocks [here][mkdocs-block]. 76 | 77 | [mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/ 78 | 79 | [mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables 80 | 81 | [mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks 82 | 83 | ## Thanks to 84 | 85 | - The creator of this awsome mkdocs plugin template: https://github.com/byrnereese/mkdocs-plugin-template 86 | -------------------------------------------------------------------------------- /RELEASE.md: -------------------------------------------------------------------------------- 1 | ## mkdocs-backlinks v0.9.1 2 | 3 | ### Changed 4 | 5 | - Add missing dependency. -------------------------------------------------------------------------------- /backlinks_plugin/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/danodic-dev/mkdocs-backlinks/df87ed1a2bfc233f9cad7b5ca583f981eb4ae06c/backlinks_plugin/__init__.py -------------------------------------------------------------------------------- /backlinks_plugin/plugin.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os 3 | from dataclasses import dataclass 4 | from typing import List, Dict, Sequence, Any, Optional 5 | 6 | from bs4 import BeautifulSoup 7 | from mkdocs.config.base import Config 8 | from mkdocs.config.config_options import ListOfItems, Type 9 | from mkdocs.config.defaults import MkDocsConfig 10 | from mkdocs.plugins import BasePlugin 11 | from mkdocs.structure.files import File, Files 12 | from mkdocs.structure.pages import Page 13 | 14 | 15 | @dataclass 16 | class Backlink: 17 | label: str 18 | destination: str 19 | 20 | 21 | class LinkScraper: 22 | 23 | def __init__(self, html: str): 24 | self.html = html 25 | 26 | def links(self): 27 | """ 28 | Scrapes the valid links from an HTML file. A valid link will not be a 29 | named anchor and will not point to an external page. 30 | :return: a list of valid links. 31 | """ 32 | links = BeautifulSoup(self.html).find_all('a') 33 | return self.__remove_invalid_links(links) 34 | 35 | def __remove_invalid_links(self, links): 36 | return [link for link in links if self.__has_href(link) and self.__is_valid_href(link.attrs['href'])] 37 | 38 | def __is_valid_href(self, href: str) -> bool: 39 | return not self.__is_named_anchor(href) and not self.__is_external_link(href) 40 | 41 | def __has_href(self, link) -> bool: 42 | return 'href' in link.attrs 43 | 44 | def __is_named_anchor(self, href: str) -> bool: 45 | return href.strip().startswith('#') 46 | 47 | def __is_external_link(self, href: str) -> bool: 48 | return href.strip().lower().startswith('http') 49 | 50 | 51 | class BacklinksPluginConfig(Config): 52 | ignored_pages = ListOfItems(Type(str), default=[]) 53 | 54 | 55 | class BacklinksPlugin(BasePlugin[BacklinksPluginConfig]): 56 | BACKLINKS_DICT_ENTRY_NAME = "backlinks" 57 | 58 | def __init__(self): 59 | super().__init__() 60 | self.files_dict = {} 61 | 62 | def on_pre_build(self, *, config: MkDocsConfig) -> None: 63 | logging.info(f"Excluded pages for backlinking: {self.config.ignored_pages}") 64 | 65 | def on_files(self, files: Files, *, config: MkDocsConfig) -> Optional[Files]: 66 | self.files_dict = self.__create_file_dict(files.documentation_pages()) 67 | return files 68 | 69 | def on_page_content(self, html, page, config, files): 70 | for link in LinkScraper(html).links(): 71 | href = link.attrs["href"] 72 | destination_link = self.__normalize_link(href, page.url) 73 | if destination_link in self.files_dict: 74 | file = self.files_dict[destination_link] 75 | self.__patch_backlinks(file, page) 76 | 77 | return html 78 | 79 | def __patch_backlinks(self, obj: Any, page): 80 | """ 81 | Will monkey-patch a list of backlinks in the object provided, and will 82 | add the page provided inside this list of backlinks. The page will 83 | not be linked to in case it has been excluded in the configurations. 84 | :param obj: an object to be monkey patched with a list of backlinks. 85 | :param page: the page to be linked to. 86 | :return: None. 87 | """ 88 | if not self.__has_backlinks(obj): 89 | obj.backlinks = [] 90 | 91 | if page in obj.backlinks or self.__is_excluded(page): 92 | return 93 | 94 | obj.backlinks.append(page) 95 | 96 | def __is_excluded(self, page: Page) -> bool: 97 | """ 98 | Checks is a page has been excluded in the configuration. 99 | :param page: the page to be checked for. 100 | :return: wheter the name of the page provided has been found inside 101 | the list of ignored pages. 102 | """ 103 | return page.title in self.config.ignored_pages 104 | 105 | def __has_backlinks(self, obj: Any) -> bool: 106 | """ 107 | Checks if an object has been monkey-patched with the backlinks list. 108 | :param obj: the object to be checked for the monkey-patching. 109 | :return: wheter the object has been monkey-patched or not. 110 | """ 111 | return hasattr(obj, self.BACKLINKS_DICT_ENTRY_NAME) 112 | 113 | def __normalize_link(self, href: str, page_url: str) -> str: 114 | """ 115 | Normalizes a link. That means: 116 | - Checking if links are relative or absolute. 117 | - Resolving their paths and normalizing them, making sure that the URLs 118 | are going to be valid when added to the HTML. 119 | - Normalization will be different, depending on the link being relative 120 | or absolute. 121 | :param href: the url scraped from the html file. 122 | :param page_url: the URL of the page that is linking to the href. 123 | :return: the normalized URL. 124 | """ 125 | if self.__is_absolute_link(href): 126 | return self.__normalize_absolute_link(href) 127 | return self.__normalize_relative_link(href, page_url) 128 | 129 | def __normalize_relative_link(self, href: str, page_url: str) -> str: 130 | link = os.path.join(page_url, href) 131 | return os.path.normpath(link) + "/" 132 | 133 | def __normalize_absolute_link(self, href: str) -> str: 134 | link = os.path.normpath(href) + "/" 135 | if link.startswith("/"): 136 | return link[1:] 137 | return link 138 | 139 | def __is_absolute_link(self, href: str): 140 | return href.startswith("/") 141 | 142 | def __create_file_dict(self, files: Sequence[File]) -> Dict[str, Sequence[File]]: 143 | """ 144 | Creates a dictionary based on the list of files provided as arguments. 145 | This is used for quickly fetching a page based on its URL. 146 | :param files: the list of files parsed by mkdocs. 147 | :return: a dictionary in which the keys are the file paths and value is 148 | the file object itself. 149 | """ 150 | return {file.url: file for file in files} 151 | 152 | def on_page_context(self, context, page, config, nav): 153 | files = context["pages"] 154 | self.__assign_backlinks_to_page_context(page.url, files, context) 155 | return context 156 | 157 | def __assign_backlinks_to_page_context(self, 158 | url: str, 159 | files: List, 160 | context: Dict): 161 | """ 162 | Mutates the jinja context provided as argument by adding the backlinks 163 | to it. Backlinks are only added in case a corresponding file for the 164 | url provided is found *and* this file has a backlinks attribute that 165 | must have been injected into the file in the previous step. 166 | :param url: the url of the page for the backlinks to be added to. 167 | :param files: the list of files that have been monkey-patched with the 168 | backlinks at a previous tep. 169 | :param context: the jinja context that will carry the variables. 170 | """ 171 | for file in files: 172 | if file.url == url: 173 | if hasattr(file, self.BACKLINKS_DICT_ENTRY_NAME): 174 | context[self.BACKLINKS_DICT_ENTRY_NAME] = file.backlinks 175 | return 176 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools>=42"] 3 | build-backend = "setuptools.build_meta" -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | 3 | with open("README.md", "r", encoding="utf-8") as fh: 4 | long_description = fh.read() 5 | 6 | setup( 7 | name='mkdocs-backlinks', 8 | version='0.9.1', 9 | description='A MkDocs plugin for adding backlinks to your documentation pages.', 10 | long_description=long_description, 11 | long_description_content_type="text/markdown", 12 | keywords='mkdocs', 13 | url='https://github.com/danodic-dev/mkdocs-backlinks', 14 | author='Danilo Guimarães', 15 | author_email='danilo@danodic.dev', 16 | license='MIT', 17 | python_requires='>=3.10', 18 | install_requires=[ 19 | 'mkdocs>=1.4.2', 20 | 'beautifulsoup4>=4.11.1' 21 | ], 22 | classifiers=[ 23 | 'Development Status :: 4 - Beta', 24 | 'Intended Audience :: Developers', 25 | 'Intended Audience :: Information Technology', 26 | 'Intended Audience :: Science/Research', 27 | 'License :: OSI Approved :: MIT License', 28 | 'Programming Language :: Python', 29 | 'Programming Language :: Python :: 3 :: Only', 30 | 'Programming Language :: Python :: 3.7', 31 | 'Programming Language :: Python :: 3.8', 32 | 'Programming Language :: Python :: 3.9', 33 | 'Programming Language :: Python :: 3.10', 34 | 'Programming Language :: Python :: 3.11' 35 | ], 36 | packages=find_packages(), 37 | entry_points={ 38 | 'mkdocs.plugins': [ 39 | 'mkdocs-backlinks = backlinks_plugin.plugin:BacklinksPlugin' 40 | ] 41 | } 42 | ) 43 | --------------------------------------------------------------------------------