Skip to content

Commit

Permalink
docs: streamline
Browse files Browse the repository at this point in the history
  • Loading branch information
hynek committed Aug 15, 2023
1 parent 88e2ef2 commit 001ae15
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 23 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Argon2 for Python
# *argon2-cffi*: Argon2 for Python

[![Documentation](https://img.shields.io/badge/Docs-Read%20The%20Docs-black)](https://argon2-cffi.readthedocs.io/)
[![License: MIT](https://img.shields.io/badge/license-MIT-C06524)](https://github.com/hynek/argon2-cffi/blob/main/LICENSE)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6671/badge)](https://bestpractices.coreinfrastructure.org/projects/6671)
[![PyPI version](https://img.shields.io/pypi/v/argon2-cffi)](https://pypi.org/project/argon2-cffi/)
[![Downloads / Month](https://static.pepy.tech/personalized-badge/argon2-cffi?period=month&units=international_system&left_color=grey&right_color=blue&left_text=Downloads%20/%20Month)](https://pepy.tech/project/argon2-cffi)

<!-- begin-short -->
<!-- begin short -->
<!-- begin pypi -->

[Argon2](https://github.com/p-h-c/phc-winner-argon2) won the [Password Hashing Competition](https://www.password-hashing.net/) and *argon2-cffi* is the simplest way to use it in Python:

Expand All @@ -26,16 +27,18 @@ Traceback (most recent call last):
argon2.exceptions.VerifyMismatchError: The password does not match the supplied hash

```
<!-- end-short -->
<!-- end short -->

## Project Links

- [**PyPI**](https://pypi.org/project/argon2-cffi/)
- [**GitHub**](https://github.com/hynek/argon2-cffi)
- [**Documentation**](https://argon2-cffi.readthedocs.io/)
- [**Changelog**](https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md)
- [**Funding**](https://hynek.me/say-thanks/)
- The low-level Argon2 CFFI bindings are maintained in the separate [*argon2-cffi-bindings*](https://github.com/hynek/argon2-cffi-bindings) project.

<!-- end pypi -->

## Credits

Expand Down
26 changes: 11 additions & 15 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,22 @@
Release **{sub-ref}`release`** ([What's new?](https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md))

```{include} ../README.md
:end-before: <!-- end-short -->
:start-after: <!-- begin-short -->
:end-before: <!-- end short -->
:start-after: <!-- begin short -->
```

If you don't know where to start, learn {doc}`argon2` and take it from there!


## Indices and Tables

- {doc}`api`
- {ref}`genindex`
- {ref}`search`

## User's Guide

```{toctree}
:hidden:
:maxdepth: 1
argon2
Expand All @@ -23,18 +31,6 @@ faq
```


## Project Links

```{include} ../README.md
:start-after: '## Project Links'
```


## Indices and tables

- {ref}`genindex`
- {ref}`search`

```{toctree}
:hidden:
:caption: Meta
Expand Down
22 changes: 17 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -71,22 +71,34 @@ content-type = "text/markdown"

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
path = "README.md"
start-after = "<!-- begin pypi -->\n"
end-before = "\n<!-- end pypi -->"

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
text = """
## Release Information
## Release Information for """
"""

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
path = "CHANGELOG.md"
start-after = "<!-- changelog follows -->"
pattern = "## ([^\n]+?\n\n)###"
pattern = "\n(###.+?\n)## "

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
path = "CHANGELOG.md"
start-after = "<!-- changelog follows -->"
pattern = "\n(###.+?\n)## "
text = """
---
[→ Full Changelog](https://github.com/hynek/svcs/blob/main/CHANGELOG.md)
"""

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
path = "README.md"
start-at = "## Credits"



[tool.pytest.ini_options]
Expand Down

0 comments on commit 001ae15

Please sign in to comment.