Merge pull request #343 from infobloxopen/bug/NIOS-84291

Fixed minor Sphinx warnings
infobloxopen · Aug 25, 2022 · 8c6f967 · 8c6f967
2 parents fcf94be + 5686ab3
commit 8c6f967
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 16 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -66,3 +66,22 @@ jobs:
         run: tox
         env:
           TOXENV: ${{ matrix.TOXENV }}
+  # This job will build the docs to validate
+  # if Sphinx doesn't return any warnings
+  sphinx:
+    name: Validate Documentation
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.6
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.6'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install sphinx
+      - name: Build documentation via Sphinx
+        run: make docs SPHINXOPTS="-W --keep-going -n"
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -4,16 +4,16 @@ History
 -------
 
 0.5.1 (2022-03-14)
------------------
+__________________
 * Updated connector's urlencoding logic for proper array encoding #287;
 * Updated InfobloxObject's fetch method to raise `InfobloxFetchGotMultipleObjects` exception #288;
 * Fix a bug when calling abstracted class from_dict with V4 & V6 subclass #282;
 
-0.5.0 (2020-05-14)
-------------------
+**0.5.0 (2020-05-14)**
+______________________
 * Majorly Updated objects with around 380+ NIOS object calls supported now.(Find the infoblox_client/objects.py file to list the supported objects and its descriptions)
 * Bug Fixes
-* python-six dependency set to >=1.11.0 
+* python-six dependency set to >=1.11.0
 
 0.4.25 (2020-03-12)
 ___________________
@@ -137,8 +137,8 @@ __________________
 __________________
 * Add 'max_results' as connector option
 
-0.4.0 (2016-02-19)
-------------------
+**0.4.0 (2016-02-19)**
+______________________
 * Add max_results option to connector and objects
 * Add Tenant object
 * Update README.rst with more examples
@@ -187,8 +187,8 @@ __________________
 * Add 'zone' to search fields of Host Record
 
 
-0.3.0 (2016-01-14)
-------------------
+**0.3.0 (2016-01-14)**
+______________________
 * Update development status from Pre-Alpha to Alpha
 * Feature/tox testing (huge changes in testing env)
 * Add 'network' to search fields of FixedAddress
@@ -216,8 +216,8 @@ __________________
 * Add 'log_api_calls_as_info' option for connector
 * Check for empty values in EA
 
-0.2.0 (2015-12-17)
-------------------
+**0.2.0 (2015-12-17)**
+______________________
 * Deprecate network_exists method in object_manager
 * Add _global_field_processing for objects
 * Add parsing 'extattrs' into EA objects for all InfobloxObject childs
@@ -312,7 +312,7 @@ ____________________
 * Fixed using dashes in package directory names that prevented package import after install.
 
 
-0.0.1 (2015-09-11)
----------------------
+**0.0.1 (2015-09-11)**
+______________________
 * Added connector to send wapi requests to NIOS, does not includes NIOS object model at this point.
 * First release on PyPI.
diff --git a/docs/conf.py b/docs/conf.py
@@ -44,6 +44,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
+    'sphinx.ext.intersphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -146,7 +147,7 @@
 # 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']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page
 # bottom, using the given strftime format.
@@ -277,3 +278,8 @@
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'requests': ('https://requests.readthedocs.io/en/latest/', None)
+}
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,6 +18,7 @@ Contents:
    contributing
    authors
    history
+   modules
 
 Indices and tables
 ==================

diff --git a/infoblox_client/connector.py b/infoblox_client/connector.py
@@ -272,7 +272,7 @@ def get_object(self, obj_type, payload=None, return_fields=None,
             A list of the Infoblox objects requested
         Raises:
             requests.exceptions.HTTPError: If API responded with error HTTP
-            status code.
+                status code.
         """
         self._validate_obj_type_or_die(obj_type, obj_type_expected=False)
 
@@ -545,7 +545,7 @@ def is_cloud_wapi(wapi_version):
             False otherwise.
 
         Raises:
-            ValueError if an invalid version is passed
+            ValueError: if an invalid version is passed
         """
         valid = wapi_version and isinstance(wapi_version, six.string_types)
         if not valid:

diff --git a/infoblox_client/objects.py b/infoblox_client/objects.py
@@ -134,7 +134,7 @@ def __repr__(self):
 
     @property
     def ea_dict(self):
-        """Returns dict with EAs in {ea_name: ea_value} format."""
+        """Returns dict with EAs in ``{ea_name: ea_value}`` format."""
         return self._ea_dict.copy()
 
     @classmethod