Skip to content

Commit 2130aa5

Browse files
Merge pull request #2096 from allmightyspiff/issues2095
Fixing sphinx-build issues
2 parents 17d8219 + 68c89b6 commit 2130aa5

File tree

4 files changed

+15
-199
lines changed

4 files changed

+15
-199
lines changed

Diff for: CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ Docs are generated with [Sphinx](https://docs.readthedocs.io/en/latest/intro/get
4242

4343
`make html` in the softlayer-python/docs directory, which should generate the HTML in `softlayer-python/docs/_build/html` for testing.
4444

45+
For windows, use:
46+
```
47+
cd docs
48+
sphinx-build -b html -d _build/doctrees . _build/html
49+
```
50+
4551

4652
## Unit Tests
4753

Diff for: Makefile

-192
This file was deleted.

Diff for: SoftLayer/CLI/bandwidth/pools_create.py

+6-4
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,11 @@
2525

2626

2727
def check_region_param(ctx, param, value): # pylint: disable=unused-argument
28-
"""Check if provided region is region group or part of region"""
28+
"""Check if provided region is region group or part of region
2929
30-
# :params string value: Region or Region-Groups
31-
# return string Region-Groups
30+
:params string value: Region or Region-Groups
31+
return string Region-Groups
32+
"""
3233

3334
region_group = None
3435
for key in location_groups:
@@ -53,10 +54,11 @@ def cli(env, name, region):
5354
"""Create bandwidth pool.
5455
5556
Region can be the full zone name 'SJC/DAL/WDC/TOR/MON', or just a single datacenter like 'SJC'.
57+
5658
Example::
5759
slcli bandwidth pool-create --name testPool --region DAL
5860
slcli bandwidth pool-create --name testPool --region SJC/DAL/WDC/TOR/MON
59-
"""
61+
"""
6062

6163
manager = BandwidthManager(env.client)
6264
locations = manager.get_location_group()

Diff for: docs/cli/bandwidth.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _cli_account:
1+
.. _cli_bandwidth:
22

3-
bandwidth Commands
4-
=================
3+
Bandwidth Commands
4+
==================
55

66

77
.. click:: SoftLayer.CLI.bandwidth.pools:cli

0 commit comments

Comments
 (0)