From: Bob Halley Date: Sun, 10 May 2020 15:50:01 +0000 (-0700) Subject: fix doco nits X-Git-Tag: v2.0.0rc1~236 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4294dd693762e3fbb3e49c63c6bdf859e5c5a46e;p=thirdparty%2Fdnspython.git fix doco nits --- diff --git a/dns/dnssec.py b/dns/dnssec.py index 171a55da..13b9c52f 100644 --- a/dns/dnssec.py +++ b/dns/dnssec.py @@ -170,18 +170,18 @@ def make_ds(name, key, algorithm, origin=None): :param name: Owner name of the DS record :type name: string :param key: a DNSKEY - :type key: :py:data:`dns.rdtypes.ANY.DNSKEY` + :type key: :py:data:`dns.rdtypes.ANY.DNSKEY.DNSKEY` :param algorithm: a string describing which hash algorithm to - use. The currently supported hashes are "SHA1" and "SHA256". Case - does not matter for these strings. + use. The currently supported hashes are "SHA1" and "SHA256". Case + does not matter for these strings. :type algorithm: string :param origin: Will be used as origin if `key` is a relative name, - defaults to None + defaults to None :type origin: :py:data:`dns.name.Name`, optional :raises UnsupportedAlgorithm: If the algorithm is not either - "SHA1" or "SHA256" exception will be thrown + "SHA1" or "SHA256" :return: a DS record - :rtype: :py:data:`dns.rdtypes.ANY.DS` + :rtype: :py:data:`dns.rdtypes.ANY.DS.DS` """ diff --git a/doc/conf.py b/doc/conf.py index 0a0e667b..9cb57254 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -60,9 +60,9 @@ author = 'Dnspython Contributors' # built documents. # # The short X.Y version. -version = '1.16' +version = '2.0' # The full version, including alpha/beta/rc tags. -release = '1.16.0' +release = '2.0.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -91,7 +91,7 @@ autoclass_content = 'both' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +#html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/doc/rdata-set-make.rst b/doc/rdata-set-make.rst index 6ada9c34..daf9ccf0 100644 --- a/doc/rdata-set-make.rst +++ b/doc/rdata-set-make.rst @@ -1,4 +1,4 @@ -.. _rdata-make: +.. _rdata-set-make: Making DNS Rdatasets and RRsets ===============================