From 6fbb70ebf20aec04b5a21640d43f21eab8493119 Mon Sep 17 00:00:00 2001 From: David Lyle Date: Tue, 18 Aug 2015 13:40:02 -0600 Subject: [PATCH] Fixing .rst file issues Correcting errors in rst file formatting. Partial-Bug: #1486222 Change-Id: Id0a703d42609165a17ca84dade94b2c04894e208 --- doc/source/contributing.rst | 2 ++ doc/source/ref/run_tests.rst | 2 +- doc/source/topics/angularjs.rst | 4 +++- doc/source/topics/javascript_testing.rst | 4 +++- doc/source/topics/settings.rst | 13 +++++++------ horizon/forms/__init__.py | 2 +- 6 files changed, 17 insertions(+), 10 deletions(-) diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 351c1feaf6..d6adadc102 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -284,6 +284,7 @@ Required 2. Avoid in-lining styles into element in HTML. Use attributes and classes instead. + * In our JS files, we should focus on logic rather than attempting to manipulate/style elements. @@ -296,6 +297,7 @@ Required 3. Avoid using classes for detection purposes only, instead, defer to attributes. For example to find a div: + .. code ::
diff --git a/doc/source/ref/run_tests.rst b/doc/source/ref/run_tests.rst index 1823aeb892..45c8cdabbc 100644 --- a/doc/source/ref/run_tests.rst +++ b/doc/source/ref/run_tests.rst @@ -187,7 +187,7 @@ You can generate various reports and metrics using command line arguments to ``run_tests.sh``. ESLint ----- +------ To run ESLint, a JavaScript code style checker:: diff --git a/doc/source/topics/angularjs.rst b/doc/source/topics/angularjs.rst index 36dcf818b8..203eb14b7a 100644 --- a/doc/source/topics/angularjs.rst +++ b/doc/source/topics/angularjs.rst @@ -146,7 +146,9 @@ Upstream JavaScript files can be discovered automatically, handled manually, or a mix of the two. Where possible, use the automated mechanism. To use the automatic functionality, add:: - AUTO_DISCOVER_STATIC_FILES = True + + AUTO_DISCOVER_STATIC_FILES = True + to your enabled file (``enabled/.py``). To make this possible, you need to follow some structural conventions: diff --git a/doc/source/topics/javascript_testing.rst b/doc/source/topics/javascript_testing.rst index 67f9dc4dbd..49a210137b 100644 --- a/doc/source/topics/javascript_testing.rst +++ b/doc/source/topics/javascript_testing.rst @@ -65,7 +65,9 @@ Jasmine uses suites and specs: ``.spec.js`` files can be handled manually or automatically. To use the automatic file discovery add:: - AUTO_DISCOVER_STATIC_FILES = True + + AUTO_DISCOVER_STATIC_FILES = True + to your enabled file. JS code for testing should use the extensions ``.mock.js`` and ``.spec.js``. diff --git a/doc/source/topics/settings.rst b/doc/source/topics/settings.rst index 19aee9a5b3..427814a882 100755 --- a/doc/source/topics/settings.rst +++ b/doc/source/topics/settings.rst @@ -512,12 +512,13 @@ OpenStack dashboard to use a specific API version for a given service API. The version should be formatted as it appears in the URL for the service API. For example, the identity service APIs have inconsistent use of the decimal point, so valid options would be "2.0" or "3". - For example, - OPENSTACK_API_VERSIONS = { - "data-processing": 1.1, - "identity": 3, - "volume": 2 - } + For example:: + + OPENSTACK_API_VERSIONS = { + "data-processing": 1.1, + "identity": 3, + "volume": 2 + } ``OPENSTACK_ENABLE_PASSWORD_RETRIEVE`` -------------------------------------- diff --git a/horizon/forms/__init__.py b/horizon/forms/__init__.py index fca0ffb3dd..e3cca03221 100644 --- a/horizon/forms/__init__.py +++ b/horizon/forms/__init__.py @@ -49,7 +49,7 @@ __all__ = [ "IPv4", "IPv6", "MultiIPField", - "SelectWidget" + "SelectWidget", # From django.forms "ValidationError",