Merge pull request #2096 from allmightyspiff/issues2095

Fixing sphinx-build issues
softlayer · Sep 29, 2023 · 2130aa5 · 2130aa5
2 parents 17d8219 + 68c89b6
commit 2130aa5
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 199 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -42,6 +42,12 @@ Docs are generated with [Sphinx](https://docs.readthedocs.io/en/latest/intro/get
 
 `make html` in the softlayer-python/docs directory, which should generate the HTML in `softlayer-python/docs/_build/html` for testing.
 
+For windows, use:
+```
+cd docs
+sphinx-build  -b html -d _build/doctrees . _build/html
+```
+
 
 ## Unit Tests
 

diff --git a/Makefile b/Makefile
diff --git a/SoftLayer/CLI/bandwidth/pools_create.py b/SoftLayer/CLI/bandwidth/pools_create.py
@@ -25,10 +25,11 @@
 
 
 def check_region_param(ctx, param, value):  # pylint: disable=unused-argument
-    """Check if provided region is region group or part of region"""
+    """Check if provided region is region group or part of region
 
-    # :params string value: Region or Region-Groups
-    # return string Region-Groups
+    :params string value: Region or Region-Groups
+    return string Region-Groups
+    """
 
     region_group = None
     for key in location_groups:
@@ -53,10 +54,11 @@ def cli(env, name, region):
     """Create bandwidth pool.
 
     Region can be the full zone name 'SJC/DAL/WDC/TOR/MON', or just a single datacenter like 'SJC'.
+
     Example::
         slcli bandwidth pool-create --name testPool --region DAL
         slcli bandwidth pool-create --name testPool --region SJC/DAL/WDC/TOR/MON
-        """
+    """
 
     manager = BandwidthManager(env.client)
     locations = manager.get_location_group()

diff --git a/docs/cli/bandwidth.rst b/docs/cli/bandwidth.rst
@@ -1,7 +1,7 @@
-.. _cli_account:
+.. _cli_bandwidth:
 
-bandwidth Commands
-=================
+Bandwidth Commands
+==================
 
 
 .. click:: SoftLayer.CLI.bandwidth.pools:cli