Skip to content

Commit

Permalink
Simplify main page
Browse files Browse the repository at this point in the history
  • Loading branch information
hynek committed Jan 13, 2024
1 parent 4b45e8c commit e3e720d
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 13 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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)
22 changes: 14 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://pypi.org/project/service-identity/>
GitHub <https://github.com/pyca/service-identity/>
Contributing <https://github.com/pyca/service-identity/blob/main/.github/CONTRIBUTING.md>
Security Policy <https://github.com/pyca/service-identity/blob/main/.github/SECURITY.md>
Funding <https://hynek.me/say-thanks/>
```
9 changes: 9 additions & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -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"
```
12 changes: 12 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e3e720d

Please sign in to comment.