From e3e720d4167b2dd2b1fdb23c96e377adb5547e65 Mon Sep 17 00:00:00 2001 From: Hynek Schlawack Date: Sat, 13 Jan 2024 13:37:43 +0100 Subject: [PATCH] Simplify main page --- README.md | 8 +++----- docs/index.md | 22 ++++++++++++++-------- docs/license.md | 9 +++++++++ tox.ini | 12 ++++++++++++ 4 files changed, 38 insertions(+), 13 deletions(-) create mode 100644 docs/license.md diff --git a/README.md b/README.md index b476488..14df8e4 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Use this package if: In the simplest case, this means *host name verification*. However, *service-identity* implements [RFC 6125](https://datatracker.ietf.org/doc/html/rfc6125.html) fully. -Please also check out [*pem*](https://github.com/hynek/pem) that makes loading certificates from all kinds of PEM-encoded files a breeze! +Also check out [*pem*](https://github.com/hynek/pem) that makes loading certificates from all kinds of PEM-encoded files a breeze! ## Project Information @@ -31,7 +31,7 @@ Please also check out [*pem*](https://github.com/hynek/pem) that makes loading c *service-identity* is written and maintained by [Hynek Schlawack](https://hynek.me/). -The development is kindly supported by my employer [Variomedia AG](https://www.variomedia.de/), *service-identity*'s [Tidelift subscribers][Tidelift], and all my amazing [GitHub Sponsors](https://github.com/sponsors/hynek). +The development is kindly supported by my employer [Variomedia AG](https://www.variomedia.de/), *service-identity*'s [Tidelift subscribers](https://tidelift.com/lifter/search/pypi/service-identity), and all my amazing [GitHub Sponsors](https://github.com/sponsors/hynek). ### *service-identity* for Enterprise @@ -40,6 +40,4 @@ Available as part of the Tidelift Subscription. The maintainers of *service-identity* and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open-source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. -[Learn more.][Tidelift] - -[Tidelift]: https://tidelift.com/subscription/pkg/pypi-service-identity?utm_source=pypi-service-identity&utm_medium=readme +[Learn more.](https://tidelift.com/lifter/search/pypi/service-identity) diff --git a/docs/index.md b/docs/index.md index 60885c5..ebca546 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,22 +17,28 @@ implemented-standards api ``` -## Project Information - -```{include} ../README.md -:start-after: "## Project Information" -``` - - ## Indices and tables - {ref}`genindex` - {ref}`search` -% Prevent warning; the changelog is linked in the header. + +## *service-identity* for Enterprise + +```{include} ../README.md +:start-after: "*service-identity* for Enterprise" +``` + ```{toctree} :hidden: +:caption: Meta +license changelog +PyPI +GitHub +Contributing +Security Policy +Funding ``` diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..cd40a21 --- /dev/null +++ b/docs/license.md @@ -0,0 +1,9 @@ +# License and Credits + +*service-identity* is released under the [MIT](https://github.com/pyca/service-identity/blob/main/LICENSE) license. + +```{include} ../README.md +:parser: myst_parser.sphinx_ +:start-after: "## Credits" +:end-before: "### *service-identity* for Enterprise" +``` diff --git a/tox.ini b/tox.ini index 0d73684..49fc423 100644 --- a/tox.ini +++ b/tox.ini @@ -52,6 +52,18 @@ commands = sphinx-build -W -b html -d {envtmpdir}/doctrees docs docs/_build/html sphinx-build -W -b doctest -d {envtmpdir}/doctrees docs docs/_build/html +[testenv:docs-watch] +package = editable +base_python = {[testenv:docs]base_python} +extras = {[testenv:docs]extras} +deps = watchfiles +commands = + watchfiles \ + --ignore-paths docs/_build/ \ + 'sphinx-build -W -n --jobs auto -b html -d {envtmpdir}/doctrees docs docs/_build/html' \ + src \ + docs + [testenv:coverage-report] # keep in-sync with .python-version-default