aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2015-07-12 10:30:59 -0500
committerAlex Gaynor <alex.gaynor@gmail.com>2015-07-12 10:30:59 -0500
commit4af5b37dfe3208706445fb1880f705236625a2f5 (patch)
tree5cb20540a1bf2d398facd6fc4274f25bfce02640 /docs
parent548e85ed63964c38fd450a4ee8753a5be2c956d5 (diff)
downloadcryptography-4af5b37dfe3208706445fb1880f705236625a2f5.tar.gz
cryptography-4af5b37dfe3208706445fb1880f705236625a2f5.tar.bz2
cryptography-4af5b37dfe3208706445fb1880f705236625a2f5.zip
Reorganize the x509 docs in prep for a tutorial
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst2
-rw-r--r--docs/x509/index.rst14
-rw-r--r--docs/x509/reference.rst (renamed from docs/x509.rst)8
3 files changed, 17 insertions, 7 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 35f80a2d..5c26a754 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -63,7 +63,7 @@ The recipes layer
:maxdepth: 2
fernet
- x509
+ x509/index
random-numbers
exceptions
faq
diff --git a/docs/x509/index.rst b/docs/x509/index.rst
new file mode 100644
index 00000000..c3fa1ed2
--- /dev/null
+++ b/docs/x509/index.rst
@@ -0,0 +1,14 @@
+X.509
+=====
+
+X.509 is an ITU-T standard for a `public key infrastructure`_. X.509v3 is
+defined in :rfc:`5280` (which obsoletes :rfc:`2459` and :rfc:`3280`). X.509
+certificates are commonly used in protocols like `TLS`_.
+
+.. toctree::
+ :maxdepth: 2
+
+ reference
+
+.. _`public key infrastructure`: https://en.wikipedia.org/wiki/Public_key_infrastructure
+.. _`TLS`: https://en.wikipedia.org/wiki/Transport_Layer_Security
diff --git a/docs/x509.rst b/docs/x509/reference.rst
index bcb6ee66..36fa972a 100644
--- a/docs/x509.rst
+++ b/docs/x509/reference.rst
@@ -1,5 +1,5 @@
-X.509
-=====
+X.509 Reference
+===============
.. currentmodule:: cryptography.x509
@@ -86,10 +86,6 @@ X.509
-----END CERTIFICATE-----
""".strip()
-X.509 is an ITU-T standard for a `public key infrastructure`_. X.509v3 is
-defined in :rfc:`5280` (which obsoletes :rfc:`2459` and :rfc:`3280`). X.509
-certificates are commonly used in protocols like `TLS`_.
-
Loading Certificates
~~~~~~~~~~~~~~~~~~~~