aboutsummaryrefslogtreecommitdiff
path: root/docs/source/pyasn1/codec
diff options
context:
space:
mode:
authorIlya Etingof <etingof@gmail.com>2017-10-11 22:09:14 +0200
committerGitHub <noreply@github.com>2017-10-11 22:09:14 +0200
commita7d88710444459a9b634a9a0735221b80ceb68c3 (patch)
tree9fe5e0cb41a2d7098499729092e3b022f53730f6 /docs/source/pyasn1/codec
parent368d2efaf46a863f8c75ddf9878a5559f246a00a (diff)
downloadpyasn1-a7d88710444459a9b634a9a0735221b80ceb68c3.tar.gz
Docs rearrangement (#88)
Docs rearranged, simplified and reworded, Sphinx theme changed.
Diffstat (limited to 'docs/source/pyasn1/codec')
-rw-r--r--docs/source/pyasn1/codec/ber/contents.rst7
-rw-r--r--docs/source/pyasn1/codec/cer/contents.rst7
-rw-r--r--docs/source/pyasn1/codec/der/contents.rst7
-rw-r--r--docs/source/pyasn1/codec/native/contents.rst7
4 files changed, 28 insertions, 0 deletions
diff --git a/docs/source/pyasn1/codec/ber/contents.rst b/docs/source/pyasn1/codec/ber/contents.rst
new file mode 100644
index 0000000..c767625
--- /dev/null
+++ b/docs/source/pyasn1/codec/ber/contents.rst
@@ -0,0 +1,7 @@
+
+Basic Encoding Rules
+--------------------
+
+.. autofunction:: pyasn1.codec.ber.encoder.encode(value, asn1Spec=None, defMode=True, maxChunkSize=0)
+
+.. autofunction:: pyasn1.codec.ber.decoder.decode(substrate, asn1Spec=None)
diff --git a/docs/source/pyasn1/codec/cer/contents.rst b/docs/source/pyasn1/codec/cer/contents.rst
new file mode 100644
index 0000000..8eec842
--- /dev/null
+++ b/docs/source/pyasn1/codec/cer/contents.rst
@@ -0,0 +1,7 @@
+
+Canonical Encoding Rules
+------------------------
+
+.. autofunction:: pyasn1.codec.cer.encoder.encode(value, asn1Spec=None)
+
+.. autofunction:: pyasn1.codec.cer.decoder.decode(substrate, asn1Spec=None)
diff --git a/docs/source/pyasn1/codec/der/contents.rst b/docs/source/pyasn1/codec/der/contents.rst
new file mode 100644
index 0000000..27ef401
--- /dev/null
+++ b/docs/source/pyasn1/codec/der/contents.rst
@@ -0,0 +1,7 @@
+
+Distinguished Encoding Rules
+----------------------------
+
+.. autofunction:: pyasn1.codec.der.encoder.encode(value, asn1Spec=None)
+
+.. autofunction:: pyasn1.codec.der.decoder.decode(substrate, asn1Spec=None)
diff --git a/docs/source/pyasn1/codec/native/contents.rst b/docs/source/pyasn1/codec/native/contents.rst
new file mode 100644
index 0000000..11e96f0
--- /dev/null
+++ b/docs/source/pyasn1/codec/native/contents.rst
@@ -0,0 +1,7 @@
+
+Native Python types
+-------------------
+
+.. autofunction:: pyasn1.codec.native.encoder.encode(asn1Value)
+
+.. autofunction:: pyasn1.codec.native.decoder.decode(pyObject, asn1Spec)