diff options
| -rw-r--r-- | .github/workflows/docs.yaml | 3 | ||||
| -rw-r--r-- | docs/mkdocs.yml | 9 | ||||
| -rw-r--r-- | poetry.lock | 89 | ||||
| -rw-r--r-- | pyproject.toml | 2 |
4 files changed, 102 insertions, 1 deletions
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 1962c1e..9755bd2 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -47,6 +47,9 @@ jobs: install_args: --with docs - name: Build docs run: poetry run mkdocs build-docs + env: + MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }} + ENABLE_GIT_PLUGINS: true - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 370f413..5e303d8 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -31,6 +31,15 @@ markdown_extensions: format: !!python/name:pymdownx.superfences.fence_code_format plugins: + # Git document contributors + - git-committers: + repository: python-discord/infra + branch: main + enabled: !ENV [ENABLE_GIT_PLUGINS, false] + # Git change information + - git-revision-date-localized: + enable_creation_date: true + enabled: !ENV [ENABLE_GIT_PLUGINS, false] # Interactive images - glightbox # Offline search diff --git a/poetry.lock b/poetry.lock index 336a556..b58d577 100644 --- a/poetry.lock +++ b/poetry.lock @@ -573,6 +573,38 @@ python-dateutil = ">=2.8.1" dev = ["flake8", "markdown", "twine", "wheel"] [[package]] +name = "gitdb" +version = "4.0.11" +description = "Git Object Database" +optional = false +python-versions = ">=3.7" +files = [ + {file = "gitdb-4.0.11-py3-none-any.whl", hash = "sha256:81a3407ddd2ee8df444cbacea00e2d038e40150acfa3001696fe0dcf1d3adfa4"}, + {file = "gitdb-4.0.11.tar.gz", hash = "sha256:bf5421126136d6d0af55bc1e7c1af1c397a34f5b7bd79e776cd3e89785c2b04b"}, +] + +[package.dependencies] +smmap = ">=3.0.1,<6" + +[[package]] +name = "gitpython" +version = "3.1.43" +description = "GitPython is a Python library used to interact with Git repositories" +optional = false +python-versions = ">=3.7" +files = [ + {file = "GitPython-3.1.43-py3-none-any.whl", hash = "sha256:eec7ec56b92aad751f9912a73404bc02ba212a23adb2c7098ee668417051a1ff"}, + {file = "GitPython-3.1.43.tar.gz", hash = "sha256:35f314a9f878467f5453cc1fee295c3e18e52f1b99f10f6cf5b1682e968a9e7c"}, +] + +[package.dependencies] +gitdb = ">=4.0.1,<5" + +[package.extras] +doc = ["sphinx (==4.3.2)", "sphinx-autodoc-typehints", "sphinx-rtd-theme", "sphinxcontrib-applehelp (>=1.0.2,<=1.0.4)", "sphinxcontrib-devhelp (==1.0.2)", "sphinxcontrib-htmlhelp (>=2.0.0,<=2.0.1)", "sphinxcontrib-qthelp (==1.0.3)", "sphinxcontrib-serializinghtml (==1.1.5)"] +test = ["coverage[toml]", "ddt (>=1.1.1,!=1.4.3)", "mock", "mypy", "pre-commit", "pytest (>=7.3.1)", "pytest-cov", "pytest-instafail", "pytest-mock", "pytest-sugar", "typing-extensions"] + +[[package]] name = "identify" version = "2.6.0" description = "File identification library for Python" @@ -845,6 +877,39 @@ platformdirs = ">=2.2.0" pyyaml = ">=5.1" [[package]] +name = "mkdocs-git-committers-plugin-2" +version = "2.3.0" +description = "An MkDocs plugin to create a list of contributors on the page. The git-committers plugin will seed the template context with a list of GitHub or GitLab committers and other useful GIT info such as last modified date" +optional = false +python-versions = ">=3.8,<4" +files = [ + {file = "mkdocs-git-committers-plugin-2-2.3.0.tar.gz", hash = "sha256:d6baca1ae04db8120640038eda8142f2d081c27b53f3b566c83c75717e4ed81a"}, + {file = "mkdocs_git_committers_plugin_2-2.3.0-py3-none-any.whl", hash = "sha256:7b3434af3be525c12858eb3b44b4c6b695b7c7b7760482ea8de1c6e292e84f0f"}, +] + +[package.dependencies] +gitpython = "*" +mkdocs = ">=1.0.3" +requests = "*" + +[[package]] +name = "mkdocs-git-revision-date-localized-plugin" +version = "1.2.6" +description = "Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file." +optional = false +python-versions = ">=3.8" +files = [ + {file = "mkdocs_git_revision_date_localized_plugin-1.2.6-py3-none-any.whl", hash = "sha256:f015cb0f3894a39b33447b18e270ae391c4e25275cac5a626e80b243784e2692"}, + {file = "mkdocs_git_revision_date_localized_plugin-1.2.6.tar.gz", hash = "sha256:e432942ce4ee8aa9b9f4493e993dee9d2cc08b3ea2b40a3d6b03ca0f2a4bcaa2"}, +] + +[package.dependencies] +babel = ">=2.7.0" +GitPython = "*" +mkdocs = ">=1.0" +pytz = "*" + +[[package]] name = "mkdocs-glightbox" version = "0.4.0" description = "MkDocs plugin supports image lightbox with GLightbox." @@ -1235,6 +1300,17 @@ files = [ six = ">=1.5" [[package]] +name = "pytz" +version = "2024.1" +description = "World timezone definitions, modern and historical" +optional = false +python-versions = "*" +files = [ + {file = "pytz-2024.1-py2.py3-none-any.whl", hash = "sha256:328171f4e3623139da4983451950b28e95ac706e13f3f2630a879749e7a8b319"}, + {file = "pytz-2024.1.tar.gz", hash = "sha256:2a29735ea9c18baf14b448846bde5a48030ed267578472d8955cd0e7443a9812"}, +] + +[[package]] name = "pyyaml" version = "6.0.1" description = "YAML parser and emitter for Python" @@ -1690,6 +1766,17 @@ files = [ ] [[package]] +name = "smmap" +version = "5.0.1" +description = "A pure Python implementation of a sliding window memory map manager" +optional = false +python-versions = ">=3.7" +files = [ + {file = "smmap-5.0.1-py3-none-any.whl", hash = "sha256:e6d8668fa5f93e706934a62d7b4db19c8d9eb8cf2adbb75ef1b675aa332b69da"}, + {file = "smmap-5.0.1.tar.gz", hash = "sha256:dceeb6c0028fdb6734471eb07c0cd2aae706ccaecab45965ee83f11c8d3b1f62"}, +] + +[[package]] name = "subprocess-tee" version = "0.4.2" description = "subprocess-tee" @@ -1892,4 +1979,4 @@ test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", [metadata] lock-version = "2.0" python-versions = ">3.11,<4.0" -content-hash = "522ae4f1fde6f8a9232b2213339d04ca3d0dca6789038dcec83e7ea7cf16c9e4" +content-hash = "34dcd1e89b1b057556fada29f1c36b32a5df1c4f9c119daab7fdf5b9b70a5571" diff --git a/pyproject.toml b/pyproject.toml index 2005306..1824c32 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,6 +27,8 @@ octodns-cloudflare = "^0.0.6" [tool.poetry.group.docs.dependencies] mkdocs-material = {extras = ["imaging"], version = "^9.5.31"} mkdocs-glightbox = "^0.4.0" +mkdocs-git-committers-plugin-2 = "^2.3.0" +mkdocs-git-revision-date-localized-plugin = "^1.2.6" [tool.taskipy.tasks] lint = "pre-commit run --all-files" |