refactoring of dnssec documentation

- replaces old comments with sphinx style comments
- adds support for sphinx.ext.todo
- since `_validate()` and `_validate_rrsig()` are only internal functions they are removed from documentation

2 files changed, 16 insertions, 18 deletions

diff --git a/doc/conf.py b/doc/conf.py
index 10211f9..f6595af 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -31,9 +31,12 @@ sys.path.insert(0, os.path.abspath('..'))
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
+extensions = [
+    'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages']
+    'sphinx.ext.githubpages',
+    'sphinx.ext.todo'
+    ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -77,7 +80,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 pygments_style = 'sphinx'
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
+todo_include_todos = True
 
 # -- Options for autodoc --------------------------------------------------
 
@@ -99,7 +102,7 @@ html_theme = 'alabaster'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # -- Options for HTMLHelp output ------------------------------------------
 
@@ -156,6 +159,3 @@ texinfo_documents = [
      author, 'dnspython', 'One line description of project.',
      'Miscellaneous'),
 ]
-
-
-
diff --git a/doc/dnssec.rst b/doc/dnssec.rst
index 115f973..eee8ea7 100644
--- a/doc/dnssec.rst
+++ b/doc/dnssec.rst
@@ -9,6 +9,14 @@ facilities for signing.  In order to use DNSSEC functions, you must have
 ``pycryptodome`` or ``pycryptodomex`` installed.  If you want to do elliptic
 curves, you must also have ``ecdsa`` installed.
 
+DNSSEC Functions
+----------------
+
+.. autofunction:: dns.dnssec.algorithm_from_text
+.. autofunction:: dns.dnssec.algorithm_to_text
+.. autofunction:: dns.dnssec.key_id
+.. autofunction:: dns.dnssec.make_ds
+
 DNSSEC Algorithms
 -----------------
 
@@ -25,14 +33,4 @@ DNSSEC Algorithms
 .. autodata:: dns.dnssec.ECDSAP384SHA384
 .. autodata:: dns.dnssec.INDIRECT
 .. autodata:: dns.dnssec.PRIVATEDNS
-.. autodata:: dns.dnssec.PRIVATEOID
-
-DNSSEC Functions
-----------------
-
-.. autofunction:: dns.dnssec.algorithm_from_text
-.. autofunction:: dns.dnssec.algorithm_to_text
-.. autofunction:: dns.dnssec.key_id
-.. autofunction:: dns.dnssec.make_ds
-.. autofunction:: dns.dnssec.validate
-.. autofunction:: dns.dnssec.validate_rrsig
+.. autodata:: dns.dnssec.PRIVATEOID
\ No newline at end of file