Skip to content

Fixing sphinx-build issues #2096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
192 changes: 0 additions & 192 deletions Makefile

This file was deleted.

10 changes: 6 additions & 4 deletions SoftLayer/CLI/bandwidth/pools_create.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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()
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/bandwidth.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _cli_account:
.. _cli_bandwidth:

bandwidth Commands
=================
Bandwidth Commands
==================


.. click:: SoftLayer.CLI.bandwidth.pools:cli
Expand Down