Added a README for vectors, for the benefit of twine check (pyca#11589)

alex · Oct 18, 2024 · b81bc10 · b81bc10
1 parent 9a3cdb5
commit b81bc10
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/noxfile.py b/noxfile.py
@@ -153,6 +153,14 @@ def docs(session: nox.Session) -> None:
     session.run(
         "python3", "-m", "readme_renderer", "README.rst", "-o", "/dev/null"
     )
+    session.run(
+        "python3",
+        "-m",
+        "readme_renderer",
+        "vectors/README.rst",
+        "-o",
+        "/dev/null",
+    )
 
 
 @nox.session(name="docs-linkcheck")

diff --git a/vectors/README.rst b/vectors/README.rst
@@ -0,0 +1,5 @@
+pyca/cryptography vectors
+=========================
+
+This package contains test vectors which are used in ``pyca/cryptography``'s
+tests.
diff --git a/vectors/pyproject.toml b/vectors/pyproject.toml
@@ -9,6 +9,7 @@ authors = [
     {name = "The Python Cryptographic Authority and individual contributors", email = "[email protected]"}
 ]
 description = "Test vectors for the cryptography package."
+readme = "README.rst"
 license = {text = "Apache-2.0 OR BSD-3-Clause"}
 
 [project.urls]