Skip to content

Commit 1665a00

Browse files
authored
Add a minimal README for themes - will be shown on PyPI (#32)
1 parent b936c5b commit 1665a00

4 files changed

Lines changed: 22 additions & 0 deletions

File tree

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# properdocs-theme-mkdocs
2+
3+
This package needs to be installed in order to use the "MkDocs" theme with the [ProperDocs](https://properdocs.org/) documentation generator:
4+
5+
pip install properdocs-theme-mkdocs
6+
7+
(See <https://properdocs.org/dev-guide/themes/>)
8+
9+
It originates as the "MkDocs" theme made for the [MkDocs](https://www.mkdocs.org/) documentation generator.

packages/properdocs-theme-mkdocs/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ build-backend = "hatchling.build"
55
[project]
66
name = "properdocs-theme-mkdocs"
77
description = "'mkdocs' theme for ProperDocs, originally made for MkDocs"
8+
readme = "README.md"
89
license = "BSD-2-Clause"
910
authors = [
1011
{name = "Tom Christie", email = "tom@tomchristie.com"},
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# properdocs-theme-readthedocs
2+
3+
This package needs to be installed in order to use the "ReadTheDocs" theme with the [ProperDocs](https://properdocs.org/) documentation generator:
4+
5+
pip install properdocs-theme-readthedocs
6+
7+
(See <https://properdocs.org/dev-guide/themes/>)
8+
9+
It is copied from the "ReadTheDocs" theme made for the [MkDocs](https://www.mkdocs.org/) documentation generator.
10+
11+
Its origin is from the "ReadTheDocs" theme for Sphinx: <https://github.com/readthedocs/sphinx_rtd_theme>

packages/properdocs-theme-readthedocs/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ build-backend = "hatchling.build"
55
[project]
66
name = "properdocs-theme-readthedocs"
77
description = "'readthedocs' theme for ProperDocs, originally made for MkDocs"
8+
readme = "README.md"
89
license = "BSD-2-Clause"
910
authors = [
1011
{name = "Tom Christie", email = "tom@tomchristie.com"},

0 commit comments

Comments
 (0)