diff --git a/docs/dev-guide/version-control.md b/docs/dev-guide/version-control.md index f94c725..08f26e4 100644 --- a/docs/dev-guide/version-control.md +++ b/docs/dev-guide/version-control.md @@ -19,8 +19,8 @@ ## CalVer and others -- Sometimes SemVer doesn't make sense. For example, in a user-facing **software - service/tool**, what does a 'breaking' change denote? +- Sometimes SemVer doesn't make sense. For example, in a user-facing + **software service/tool**, what does a 'breaking' change denote? - In these cases, other conventions may be better suited. - At HOT, we use `YYYY.VERSION.PATCH`, in line with the developers of the ODK ecosystem. - YYYY: the current year. diff --git a/pdm.lock b/pdm.lock index cc0da51..3f71be0 100644 --- a/pdm.lock +++ b/pdm.lock @@ -3,10 +3,9 @@ [metadata] groups = ["default", "docs"] -cross_platform = true -static_urls = false -lock_version = "4.3" -content_hash = "sha256:a2934e544b099027a2ead41ef1e66a63878f974bbe69ee103d73d33b1dfd6d35" +strategy = ["cross_platform"] +lock_version = "4.4.1" +content_hash = "sha256:b7f3b237244300954880be79dce92b9bffa1895e3e649bd5f73c026995a4f787" [[package]] name = "babel" @@ -103,6 +102,32 @@ files = [ {file = "ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619"}, ] +[[package]] +name = "gitdb" +version = "4.0.11" +requires_python = ">=3.7" +summary = "Git Object Database" +dependencies = [ + "smmap<6,>=3.0.1", +] +files = [ + {file = "gitdb-4.0.11-py3-none-any.whl", hash = "sha256:81a3407ddd2ee8df444cbacea00e2d038e40150acfa3001696fe0dcf1d3adfa4"}, + {file = "gitdb-4.0.11.tar.gz", hash = "sha256:bf5421126136d6d0af55bc1e7c1af1c397a34f5b7bd79e776cd3e89785c2b04b"}, +] + +[[package]] +name = "gitpython" +version = "3.1.41" +requires_python = ">=3.7" +summary = "GitPython is a Python library used to interact with Git repositories" +dependencies = [ + "gitdb<5,>=4.0.1", +] +files = [ + {file = "GitPython-3.1.41-py3-none-any.whl", hash = "sha256:c36b6634d069b3f719610175020a9aed919421c87552185b085e04fbbdb10b7c"}, + {file = "GitPython-3.1.41.tar.gz", hash = "sha256:ed66e624884f76df22c8e16066d567aaa5a37d5b5fa19db2c6df6f7156db9048"}, +] + [[package]] name = "idna" version = "3.4" @@ -175,6 +200,18 @@ files = [ {file = "MarkupSafe-2.1.3.tar.gz", hash = "sha256:af598ed32d6ae86f1b747b82783958b1a4ab8f617b06fe68795c7f026abbdcad"}, ] +[[package]] +name = "mdx-truly-sane-lists" +version = "1.3" +summary = "Extension for Python-Markdown that makes lists truly sane. Custom indents for nested lists and fix for messy linebreaks." +dependencies = [ + "Markdown>=2.6", +] +files = [ + {file = "mdx_truly_sane_lists-1.3-py3-none-any.whl", hash = "sha256:b9546a4c40ff8f1ab692f77cee4b6bfe8ddf9cccf23f0a24e71f3716fe290a37"}, + {file = "mdx_truly_sane_lists-1.3.tar.gz", hash = "sha256:b661022df7520a1e113af7c355c62216b384c867e4f59fb8ee7ad511e6e77f45"}, +] + [[package]] name = "mergedeep" version = "1.3.4" @@ -210,6 +247,22 @@ files = [ {file = "mkdocs-1.5.3.tar.gz", hash = "sha256:eb7c99214dcb945313ba30426c2451b735992c73c2e10838f76d09e39ff4d0e2"}, ] +[[package]] +name = "mkdocs-git-revision-date-localized-plugin" +version = "1.2.4" +requires_python = ">=3.8" +summary = "Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file." +dependencies = [ + "GitPython", + "babel>=2.7.0", + "mkdocs>=1.0", + "pytz", +] +files = [ + {file = "mkdocs-git-revision-date-localized-plugin-1.2.4.tar.gz", hash = "sha256:08fd0c6f33c8da9e00daf40f7865943113b3879a1c621b2bbf0fa794ffe997d3"}, + {file = "mkdocs_git_revision_date_localized_plugin-1.2.4-py3-none-any.whl", hash = "sha256:1f94eb510862ef94e982a2910404fa17a1657ecf29f45a07b0f438c00767fc85"}, +] + [[package]] name = "mkdocs-material" version = "9.4.2" @@ -318,6 +371,15 @@ files = [ {file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"}, ] +[[package]] +name = "pytz" +version = "2024.1" +summary = "World timezone definitions, modern and historical" +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" @@ -426,6 +488,16 @@ files = [ {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, ] +[[package]] +name = "smmap" +version = "5.0.1" +requires_python = ">=3.7" +summary = "A pure Python implementation of a sliding window memory map manager" +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 = "urllib3" version = "2.0.5" diff --git a/pyproject.toml b/pyproject.toml index 4df4fef..da880ef 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -20,6 +20,8 @@ repository = "https://github.com/hotosm/docs" docs = [ "mkdocs>=1.5.3", "mkdocs-material>=9.4.2", + "mdx-truly-sane-lists>=1.3", + "mkdocs-git-revision-date-localized-plugin>=1.2.4", ] [tool.commitizen] name = "cz_conventional_commits"