summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Ballet <jon@multani.info>2011-07-16 14:22:14 +0900
committerJonathan Ballet <jon@multani.info>2011-07-16 14:22:14 +0900
commit6a0b57b48f2989328a43ea8127ab81634b127868 (patch)
tree3cb2d2861e63ab4982cf738bb3a976e39c03d9fa
parent648875f669d28a889671fd93fc6b1fec8613c056 (diff)
downloadpyopenssl-6a0b57b48f2989328a43ea8127ab81634b127868.tar.gz
Fix most of the doc compilation warning/errors
There's still a "<autodoc>:: (ERROR/3) Unknown target name: "ssleay"." error though :(
-rw-r--r--OpenSSL/crypto/x509.c12
-rw-r--r--OpenSSL/ssl/context.c2
2 files changed, 8 insertions, 6 deletions
diff --git a/OpenSSL/crypto/x509.c b/OpenSSL/crypto/x509.c
index ab8348f..4329ddb 100644
--- a/OpenSSL/crypto/x509.c
+++ b/OpenSSL/crypto/x509.c
@@ -254,7 +254,7 @@ static char crypto_X509_set_subject_doc[] = "\n\
Set the subject of the certificate\n\
\n\
:param subject: The subject name\n\
-:type subject: :FOOBAR:`X509Name`\n\
+:type subject: :py:class:`X509Name`\n\
:return: None\n\
";
@@ -433,12 +433,13 @@ _get_asn1_time(char *format, ASN1_TIME* timestamp, PyObject *args)
static char crypto_X509_get_notBefore_doc[] = "\n\
Retrieve the time stamp for when the certificate starts being valid\n\
\n\
-:return: A string giving the timestamp, in the format:\n\
+:return: A string giving the timestamp, in the format::\n\
\n\
YYYYMMDDhhmmssZ\n\
YYYYMMDDhhmmss+hhmm\n\
YYYYMMDDhhmmss-hhmm\n\
- or None if there is no value set.\n\
+\n\
+ or None if there is no value set.\n\
";
static PyObject*
@@ -455,12 +456,13 @@ crypto_X509_get_notBefore(crypto_X509Obj *self, PyObject *args)
static char crypto_X509_get_notAfter_doc[] = "\n\
Retrieve the time stamp for when the certificate stops being valid\n\
\n\
-:return: A string giving the timestamp, in the format:\n\
+:return: A string giving the timestamp, in the format::\n\
\n\
YYYYMMDDhhmmssZ\n\
YYYYMMDDhhmmss+hhmm\n\
YYYYMMDDhhmmss-hhmm\n\
- or None if there is no value set.\n\
+\n\
+ or None if there is no value set.\n\
";
static PyObject*
diff --git a/OpenSSL/ssl/context.c b/OpenSSL/ssl/context.c
index 9f936f4..d0b49cb 100644
--- a/OpenSSL/ssl/context.c
+++ b/OpenSSL/ssl/context.c
@@ -667,7 +667,7 @@ ssl_Context_check_privatekey(ssl_ContextObj *self, PyObject *args)
}
static char ssl_Context_load_client_ca_doc[] = "\n\
-Load the trusted certificates that will be sent to the client (basically\n \
+Load the trusted certificates that will be sent to the client (basically\n\
telling the client \"These are the guys I trust\"). Does not actually\n\
imply any of the certificates are trusted; that must be configured\n\
separately.\n\