From 1ccc8d154c012bf9306b686cefe575c18894f1a9 Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Mon, 16 Mar 2026 00:20:22 +0100 Subject: [PATCH] Add a minimal README for themes - will be shown on PyPI --- packages/properdocs-theme-mkdocs/README.md | 9 +++++++++ packages/properdocs-theme-mkdocs/pyproject.toml | 1 + packages/properdocs-theme-readthedocs/README.md | 11 +++++++++++ packages/properdocs-theme-readthedocs/pyproject.toml | 1 + 4 files changed, 22 insertions(+) create mode 100644 packages/properdocs-theme-mkdocs/README.md create mode 100644 packages/properdocs-theme-readthedocs/README.md diff --git a/packages/properdocs-theme-mkdocs/README.md b/packages/properdocs-theme-mkdocs/README.md new file mode 100644 index 00000000..4482ae36 --- /dev/null +++ b/packages/properdocs-theme-mkdocs/README.md @@ -0,0 +1,9 @@ +# properdocs-theme-mkdocs + +This package needs to be installed in order to use the "MkDocs" theme with the [ProperDocs](https://properdocs.org/) documentation generator: + + pip install properdocs-theme-mkdocs + +(See ) + +It originates as the "MkDocs" theme made for the [MkDocs](https://www.mkdocs.org/) documentation generator. diff --git a/packages/properdocs-theme-mkdocs/pyproject.toml b/packages/properdocs-theme-mkdocs/pyproject.toml index 20f71a62..22034d7c 100644 --- a/packages/properdocs-theme-mkdocs/pyproject.toml +++ b/packages/properdocs-theme-mkdocs/pyproject.toml @@ -5,6 +5,7 @@ build-backend = "hatchling.build" [project] name = "properdocs-theme-mkdocs" description = "'mkdocs' theme for ProperDocs, originally made for MkDocs" +readme = "README.md" license = "BSD-2-Clause" authors = [ {name = "Tom Christie", email = "tom@tomchristie.com"}, diff --git a/packages/properdocs-theme-readthedocs/README.md b/packages/properdocs-theme-readthedocs/README.md new file mode 100644 index 00000000..b86e3284 --- /dev/null +++ b/packages/properdocs-theme-readthedocs/README.md @@ -0,0 +1,11 @@ +# properdocs-theme-readthedocs + +This package needs to be installed in order to use the "ReadTheDocs" theme with the [ProperDocs](https://properdocs.org/) documentation generator: + + pip install properdocs-theme-readthedocs + +(See ) + +It is copied from the "ReadTheDocs" theme made for the [MkDocs](https://www.mkdocs.org/) documentation generator. + +Its origin is from the "ReadTheDocs" theme for Sphinx: diff --git a/packages/properdocs-theme-readthedocs/pyproject.toml b/packages/properdocs-theme-readthedocs/pyproject.toml index 3f9f45f5..df0eca53 100644 --- a/packages/properdocs-theme-readthedocs/pyproject.toml +++ b/packages/properdocs-theme-readthedocs/pyproject.toml @@ -5,6 +5,7 @@ build-backend = "hatchling.build" [project] name = "properdocs-theme-readthedocs" description = "'readthedocs' theme for ProperDocs, originally made for MkDocs" +readme = "README.md" license = "BSD-2-Clause" authors = [ {name = "Tom Christie", email = "tom@tomchristie.com"},