docs - sphinx - fail on warnings (hvac#949)

* docs - sphinx - fail on warnings

* fix invalid line in cert documentation

* fix markdown files

* pin docutils to fix issue with sphinx

CHANGELOG.md

@@ -81,7 +81,7 @@ Breakfix release to revert some unintended post-1.0 requirements changes.
 
 - **Note**: This is _actually and truly_ (😝)  intended to by the last hvac release supporting Python 2.7.
 
-  **_Starting with hvac version `1.0.0`, Python versions `>=3.6` will be the only explictly supported versions._**
+  **Starting with hvac version `1.0.0`, Python versions `>=3.6` will be the only explictly supported versions.**
 - Requirements - Cleanup & Upgrades (`install_requires` => `requests>=2.25.1` ). GH-741
 
 ### 🚀 Features
@@ -105,7 +105,7 @@ Thanks to @Tylerlhess, @anhdat, @ayav09, @bobmshannon, @bpatterson971, @briantis
 
 - **Note**: This is intended to by the last hvac release supporting Python 2.7.
 
-  **_Starting with hvac version `1.0.0`, Python versions `>=3.6` will be the only explictly supported versions._**
+  **Starting with hvac version `1.0.0`, Python versions `>=3.6` will be the only explictly supported versions.**
 - Userpass: Add `use_token` param on `login()`, Accept passthrough `**kwargs` on create user . GH-733
 
 ### 🚀 Features
@@ -157,7 +157,7 @@ Thanks to @Tylerlhess, @jeffwecan, @matusf, @mblau-leaffilter and tyhess for the
 ### 🚀 Features
 
 - Expand Transform class to include new(ish) tokenization methods. GH-696
-- Add `delete_version_after` KvV2 Param - `configure()` / `update_metadata(). GH-694
+- Add `delete_version_after` KvV2 Param - `configure()` / `update_metadata()`. GH-694
 
 ### 🧰 Miscellaneous
 

README.md

@@ -1,7 +1,5 @@
 # hvac
 
-----
-
 ![Header image](https://raw.githubusercontent.com/hvac/hvac/main/docs/_static/hvac_logo_800px.png)
 
 [HashiCorp](https://hashicorp.com/) [Vault](https://www.vaultproject.io) API client for Python 3.x
@@ -16,7 +14,7 @@
 Tested against the latest release, HEAD ref, and 3 previous minor versions (counting back from the latest release) of Vault.
 Current official support covers Vault v1.4.7 or later.
 
-> **_NOTE:_**  Support for EOL Python versions will be dropped at the end of 2022.  Starting in 2023, hvac will track
+> **NOTE:**  Support for EOL Python versions will be dropped at the end of 2022.  Starting in 2023, hvac will track
 > with the CPython EOL dates.
 
 ## Installation

docs/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -E -a
+SPHINXOPTS    = -E -a -W --keep-going
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = hvac
 SOURCEDIR     = .

hvac/api/auth_methods/cert.py

@@ -44,7 +44,6 @@ def create_ca_certificate_role(
         Supported methods:
             POST:	/auth/<mount point>/certs/:name. Produces: 204 (empty body)
 
-        »Parameters
         :param name: The name of the certificate role.
         :type name: str
         :param certificate: The PEM-format CA certificate. Either certificate or certificate_file is required.

pyproject.toml

@@ -57,6 +57,7 @@ m2r2 = "0.2.5"
 Sphinx = "3.1.2"
 sphinx-rtd-theme = "0.5.0"
 mistune = "0.8.4"
+docutils = "<0.18"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]