]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/conf: wrap lines over 79 chars
authorKefu Chai <kchai@redhat.com>
Fri, 20 Nov 2020 03:28:36 +0000 (11:28 +0800)
committerKefu Chai <kchai@redhat.com>
Fri, 20 Nov 2020 04:59:22 +0000 (12:59 +0800)
to be compliant with PEP8, see
https://www.python.org/dev/peps/pep-0008/#id19

also silences flake8 warning of

E501 line too long

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/conf.py

index 2c285811c9135a73f2b80968a5b9ae9d8a07cc81..87a26c77f4e393b39fa7a017c7e82710ed2fbc7f 100644 (file)
@@ -4,17 +4,25 @@ import sys
 import os
 
 project = 'Ceph'
-copyright = '2016, Ceph authors and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)'
+copyright = ('2016, Ceph authors and contributors. '
+             'Licensed under Creative Commons Attribution Share Alike 3.0 '
+             '(CC-BY-SA-3.0)')
 version = 'dev'
 release = 'dev'
 
 templates_path = ['_templates']
 source_suffix = '.rst'
 master_doc = 'index'
-exclude_patterns = ['**/.#*', '**/*~', 'start/quick-common.rst', '**/*.inc.rst']
+exclude_patterns = ['**/.#*',
+                    '**/*~',
+                    'start/quick-common.rst',
+                    '**/*.inc.rst']
 if tags.has('man'):             # noqa: F821
     master_doc = 'man_index'
-    exclude_patterns += ['index.rst', 'architecture.rst', 'glossary.rst', 'release*.rst',
+    exclude_patterns += ['index.rst',
+                         'architecture.rst',
+                         'glossary.rst',
+                         'release*.rst',
                          'api/*',
                          'cephadm/*',
                          'cephfs/*',
@@ -101,7 +109,9 @@ breathe_projects_source = {
     "Ceph": (os.path.join(top_level, "src/include/rados"),
              ["rados_types.h", "librados.h"])
 }
-breathe_domain_by_extension = {'py': 'py', 'c': 'c', 'h': 'c', 'cc': 'cxx', 'hpp': 'cxx'}
+breathe_domain_by_extension = {'py': 'py',
+                               'c': 'c', 'h': 'c',
+                               'cc': 'cxx', 'hpp': 'cxx'}
 breathe_doxygen_config_options = {
     'EXPAND_ONLY_PREDEF': 'YES',
     'MACRO_EXPANSION': 'YES',
@@ -141,9 +151,10 @@ def setup(app):
         # add "ditaa" as an alias of "diagram"
         from plantweb.directive import DiagramDirective
         app.add_directive('ditaa', DiagramDirective)
-    app.connect('builder-inited', generate_state_diagram(['src/osd/PeeringState.h',
-                                                          'src/osd/PeeringState.cc'],
-                                                         'doc/dev/peering_graph.generated.dot'))
+    app.connect('builder-inited',
+                generate_state_diagram(['src/osd/PeeringState.h',
+                                        'src/osd/PeeringState.cc'],
+                                       'doc/dev/peering_graph.generated.dot'))
 
 
 # mocking ceph_module offered by ceph-mgr. `ceph_module` is required by