Fix links and titles to docs (#239)

Change the title of each doc to match the name of the rule. Also added missing docs. Signed-off-by: Eric Brown <eric.brown@securesauce.dev>
securesauce · Jan 28, 2024 · 5661aee · 5661aee
1 parent 0abd2bb
commit 5661aee
Show file tree

Hide file tree

Showing 26 changed files with 91 additions and 59 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,4 +5,5 @@ Rule Listing
 .. toctree::
    :maxdepth: 1
 
+   rules/go/index
    rules/python/index
diff --git a/docs/source/rules/go/index.rst b/docs/source/rules/go/index.rst
@@ -0,0 +1,8 @@
+Go
+==
+
+
+.. toctree::
+   :maxdepth: 1
+
+   stdlib/index
diff --git a/docs/source/rules/go/stdlib/crypto_weak_cipher.rst b/docs/source/rules/go/stdlib/crypto_weak_cipher.rst
@@ -0,0 +1,5 @@
+====================
+crypto — weak cipher
+====================
+
+.. automodule:: precli.rules.go.stdlib.crypto_weak_cipher
diff --git a/docs/source/rules/go/stdlib/crypto_weak_hash.rst b/docs/source/rules/go/stdlib/crypto_weak_hash.rst
@@ -0,0 +1,5 @@
+==================
+crypto — weak hash
+==================
+
+.. automodule:: precli.rules.go.stdlib.crypto_weak_hash
diff --git a/docs/source/rules/go/stdlib/crypto_weak_key.rst b/docs/source/rules/go/stdlib/crypto_weak_key.rst
@@ -0,0 +1,5 @@
+=================
+crypto — weak key
+=================
+
+.. automodule:: precli.rules.go.stdlib.crypto_weak_key
diff --git a/docs/source/rules/go/stdlib/index.rst b/docs/source/rules/go/stdlib/index.rst
@@ -0,0 +1,8 @@
+Standard Library
+================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   *
diff --git a/docs/source/rules/python/stdlib/assert.rst b/docs/source/rules/python/stdlib/assert.rst
diff --git a/docs/source/rules/python/stdlib/crypt_weak_hash.rst b/docs/source/rules/python/stdlib/crypt_weak_hash.rst
@@ -1,5 +1,5 @@
-=======
-PRE0002
-=======
+=================
+crypt — weak hash
+=================
 
 .. automodule:: precli.rules.python.stdlib.crypt_weak_hash
diff --git a/docs/source/rules/python/stdlib/ftplib_cleartext.rst b/docs/source/rules/python/stdlib/ftplib_cleartext.rst
@@ -1,5 +1,5 @@
-=======
-PRE0003
-=======
+==================
+ftplib — cleartext
+==================
 
 .. automodule:: precli.rules.python.stdlib.ftplib_cleartext
diff --git a/docs/source/rules/python/stdlib/hashlib_weak_hash.rst b/docs/source/rules/python/stdlib/hashlib_weak_hash.rst
@@ -1,5 +1,5 @@
-=======
-PRE0004
-=======
+===================
+hashlib — weak hash
+===================
 
 .. automodule:: precli.rules.python.stdlib.hashlib_weak_hash
diff --git a/docs/source/rules/python/stdlib/hmac_timing_attack.rst b/docs/source/rules/python/stdlib/hmac_timing_attack.rst
@@ -1,5 +1,5 @@
-=======
-PRE0005
-=======
+====================
+hmac — timing attack
+====================
 
 .. automodule:: precli.rules.python.stdlib.hmac_timing_attack
diff --git a/docs/source/rules/python/stdlib/hmac_weak_hash.rst b/docs/source/rules/python/stdlib/hmac_weak_hash.rst
@@ -1,5 +1,5 @@
-=======
-PRE0005
-=======
+================
+hmac — weak hash
+================
 
 .. automodule:: precli.rules.python.stdlib.hmac_weak_hash
diff --git a/docs/source/rules/python/stdlib/imaplib_cleartext.rst b/docs/source/rules/python/stdlib/imaplib_cleartext.rst
@@ -1,5 +1,5 @@
-=======
-PRE0005
-=======
+===================
+imaplib — cleartext
+===================
 
 .. automodule:: precli.rules.python.stdlib.imaplib_cleartext
diff --git a/docs/source/rules/python/stdlib/json_load.rst b/docs/source/rules/python/stdlib/json_load.rst
@@ -1,5 +1,5 @@
-=======
-PRE0006
-=======
+===========
+json — load
+===========
 
 .. automodule:: precli.rules.python.stdlib.json_load
diff --git a/docs/source/rules/python/stdlib/logging_insecure_listen_config.rst b/docs/source/rules/python/stdlib/logging_insecure_listen_config.rst
@@ -1,5 +1,5 @@
-=======
-PRE0007
-=======
+================================
+logging — insecure listen config
+================================
 
 .. automodule:: precli.rules.python.stdlib.logging_insecure_listen_config
diff --git a/docs/source/rules/python/stdlib/marshal_load.rst b/docs/source/rules/python/stdlib/marshal_load.rst
@@ -1,5 +1,5 @@
-=======
-PRE0008
-=======
+==============
+marshal — load
+==============
 
 .. automodule:: precli.rules.python.stdlib.marshal_load
diff --git a/docs/source/rules/python/stdlib/nntplib_cleartext.rst b/docs/source/rules/python/stdlib/nntplib_cleartext.rst
@@ -1,5 +1,5 @@
-=======
-PRE0008
-=======
+===================
+nntplib — cleartext
+===================
 
 .. automodule:: precli.rules.python.stdlib.nntplib_cleartext
diff --git a/docs/source/rules/python/stdlib/pickle_load.rst b/docs/source/rules/python/stdlib/pickle_load.rst
@@ -1,5 +1,5 @@
-=======
-PRE0009
-=======
+=============
+pickle — load
+=============
 
 .. automodule:: precli.rules.python.stdlib.pickle_load
diff --git a/docs/source/rules/python/stdlib/poplib_cleartext.rst b/docs/source/rules/python/stdlib/poplib_cleartext.rst
@@ -1,5 +1,5 @@
-=======
-PRE0009
-=======
+==================
+poplib — cleartext
+==================
 
 .. automodule:: precli.rules.python.stdlib.poplib_cleartext
diff --git a/docs/source/rules/python/stdlib/shelve_open.rst b/docs/source/rules/python/stdlib/shelve_open.rst
@@ -1,5 +1,5 @@
-=======
-PRE0010
-=======
+=============
+shelve — open
+=============
 
 .. automodule:: precli.rules.python.stdlib.shelve_open
diff --git a/docs/source/rules/python/stdlib/smtplib_cleartext.rst b/docs/source/rules/python/stdlib/smtplib_cleartext.rst
@@ -1,5 +1,5 @@
-=======
-PRE0010
-=======
+===================
+smtplib — cleartext
+===================
 
 .. automodule:: precli.rules.python.stdlib.smtplib_cleartext
diff --git a/docs/source/rules/python/stdlib/ssl_context_weak_key.rst b/docs/source/rules/python/stdlib/ssl_context_weak_key.rst
@@ -0,0 +1,5 @@
+==============
+ssl — weak key
+==============
+
+.. automodule:: precli.rules.python.stdlib.ssl_context_weak_key
diff --git a/docs/source/rules/python/stdlib/ssl_create_unverified_context.rst b/docs/source/rules/python/stdlib/ssl_create_unverified_context.rst
@@ -1,5 +1,5 @@
-=======
-PRE0011
-=======
+===============================
+ssl — create unverified context
+===============================
 
 .. automodule:: precli.rules.python.stdlib.ssl_create_unverified_context
diff --git a/docs/source/rules/python/stdlib/ssl_insecure_tls_version.rst b/docs/source/rules/python/stdlib/ssl_insecure_tls_version.rst
@@ -1,5 +1,5 @@
-=======
-PRE0012
-=======
+==========================
+ssl — insecure tls version
+==========================
 
 .. automodule:: precli.rules.python.stdlib.ssl_insecure_tls_version
diff --git a/docs/source/rules/python/stdlib/telnetlib_cleartext.rst b/docs/source/rules/python/stdlib/telnetlib_cleartext.rst
@@ -1,5 +1,5 @@
-=======
-PRE0013
-=======
+=====================
+telnetlib — cleartext
+=====================
 
 .. automodule:: precli.rules.python.stdlib.telnetlib_cleartext
diff --git a/docs/source/rules/python/stdlib/tempfile_mktemp_race_condition.rst b/docs/source/rules/python/stdlib/tempfile_mktemp_race_condition.rst
@@ -1,5 +1,5 @@
-=======
-PRE0013
-=======
+================================
+tempfile — mktemp race condition
+================================
 
 .. automodule:: precli.rules.python.stdlib.tempfile_mktemp_race_condition