Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit290e5ed

Browse files
authored
Merge pull request#775 from python-gitlab/refactor/black
refactor: format everything black
2 parentsef32990 +318d277 commit290e5ed

25 files changed

+3301
-2622
lines changed

‎.gitlab-ci.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@ commitlint:
1717
except:
1818
-master
1919

20+
black_lint:
21+
stage:lint
22+
before_script:
23+
-pip3 install black
24+
script:
25+
-black --check .
26+
except:
27+
-master
28+
2029
#build_test_image: # Currently hangs forever, because of GitLab Runner infrastructure issues
2130
# stage: build-test-image
2231
# image:

‎docs/conf.py

Lines changed: 88 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -20,44 +20,42 @@
2020

2121
importsphinx
2222

23-
sys.path.append('../')
23+
sys.path.append("../")
2424
sys.path.append(os.path.dirname(__file__))
2525
importgitlab
2626

27-
on_rtd=os.environ.get('READTHEDOCS',None)=='True'
27+
on_rtd=os.environ.get("READTHEDOCS",None)=="True"
2828

2929
# If extensions (or modules to document with autodoc) are in another directory,
3030
# add these directories to sys.path here. If the directory is relative to the
3131
# documentation root, use os.path.abspath to make it absolute, like shown here.
32-
sys.path.insert(0,os.path.abspath('..'))
32+
sys.path.insert(0,os.path.abspath(".."))
3333

3434
# -- General configuration ------------------------------------------------
3535

3636
# If your documentation needs a minimal Sphinx version, state it here.
37-
#needs_sphinx = '1.0'
37+
#needs_sphinx = '1.0'
3838

3939
# Add any Sphinx extension module names here, as strings. They can be
4040
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
4141
# ones.
42-
extensions= [
43-
'sphinx.ext.autodoc','sphinx.ext.autosummary','ext.docstrings'
44-
]
42+
extensions= ["sphinx.ext.autodoc","sphinx.ext.autosummary","ext.docstrings"]
4543

4644
# Add any paths that contain templates here, relative to this directory.
47-
templates_path= ['_templates']
45+
templates_path= ["_templates"]
4846

4947
# The suffix of source filenames.
50-
source_suffix='.rst'
48+
source_suffix=".rst"
5149

5250
# The encoding of source files.
53-
#source_encoding = 'utf-8-sig'
51+
#source_encoding = 'utf-8-sig'
5452

5553
# The master toctree document.
56-
master_doc='index'
54+
master_doc="index"
5755

5856
# General information about the project.
59-
project='python-gitlab'
60-
copyright='2013-2018, Gauvain Pocentek, Mika Mäenpää'
57+
project="python-gitlab"
58+
copyright="2013-2018, Gauvain Pocentek, Mika Mäenpää"
6159

6260
# The version info for the project you're documenting, acts as replacement for
6361
# |version| and |release|, also used in various other places throughout the
@@ -70,188 +68,197 @@
7068

7169
# The language for content autogenerated by Sphinx. Refer to documentation
7270
# for a list of supported languages.
73-
#language = None
71+
#language = None
7472

7573
# There are two options for replacing |today|: either, you set today to some
7674
# non-false value, then it is used:
77-
#today = ''
75+
#today = ''
7876
# Else, today_fmt is used as the format for a strftime call.
79-
#today_fmt = '%B %d, %Y'
77+
#today_fmt = '%B %d, %Y'
8078

8179
# List of patterns, relative to source directory, that match files and
8280
# directories to ignore when looking for source files.
83-
exclude_patterns= ['_build']
81+
exclude_patterns= ["_build"]
8482

8583
# The reST default role (used for this markup: `text`) to use for all
8684
# documents.
87-
#default_role = None
85+
#default_role = None
8886

8987
# If true, '()' will be appended to :func: etc. cross-reference text.
90-
#add_function_parentheses = True
88+
#add_function_parentheses = True
9189

9290
# If true, the current module name will be prepended to all description
9391
# unit titles (such as .. function::).
94-
#add_module_names = True
92+
#add_module_names = True
9593

9694
# If true, sectionauthor and moduleauthor directives will be shown in the
9795
# output. They are ignored by default.
98-
#show_authors = False
96+
#show_authors = False
9997

10098
# The name of the Pygments (syntax highlighting) style to use.
101-
pygments_style='sphinx'
99+
pygments_style="sphinx"
102100

103101
# A list of ignored prefixes for module index sorting.
104-
#modindex_common_prefix = []
102+
#modindex_common_prefix = []
105103

106104
# If true, keep warnings as "system message" paragraphs in the built documents.
107-
#keep_warnings = False
105+
#keep_warnings = False
108106

109107

110108
# -- Options for HTML output ----------------------------------------------
111109

112110
# The theme to use for HTML and HTML Help pages. See the documentation for
113111
# a list of builtin themes.
114-
html_theme='default'
115-
ifnoton_rtd:# only import and set the theme if we're building docs locally
112+
html_theme="default"
113+
ifnoton_rtd:# only import and set the theme if we're building docs locally
116114
try:
117115
importsphinx_rtd_theme
118-
html_theme='sphinx_rtd_theme'
116+
117+
html_theme="sphinx_rtd_theme"
119118
html_theme_path= [sphinx_rtd_theme.get_html_theme_path()]
120-
exceptImportError:# Theme not found, use default
119+
exceptImportError:# Theme not found, use default
121120
pass
122121

123122
# Theme options are theme-specific and customize the look and feel of a theme
124123
# further. For a list of options available for each theme, see the
125124
# documentation.
126-
#html_theme_options = {}
125+
#html_theme_options = {}
127126

128127
# Add any paths that contain custom themes here, relative to this directory.
129-
#html_theme_path = []
128+
#html_theme_path = []
130129

131130
# The name for this set of Sphinx documents. If None, it defaults to
132131
# "<project> v<release> documentation".
133-
#html_title = None
132+
#html_title = None
134133

135134
# A shorter title for the navigation bar. Default is the same as html_title.
136-
#html_short_title = None
135+
#html_short_title = None
137136

138137
# The name of an image file (relative to this directory) to place at the top
139138
# of the sidebar.
140-
#html_logo = None
139+
#html_logo = None
141140

142141
# The name of an image file (within the static path) to use as favicon of the
143142
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
144143
# pixels large.
145-
#html_favicon = None
144+
#html_favicon = None
146145

147146
# Add any paths that contain custom static files (such as style sheets) here,
148147
# relative to this directory. They are copied after the builtin static files,
149148
# so a file named "default.css" will overwrite the builtin "default.css".
150-
#html_static_path = ['_static']
149+
#html_static_path = ['_static']
151150

152151
# Add any extra paths that contain custom files (such as robots.txt or
153152
# .htaccess) here, relative to this directory. These files are copied
154153
# directly to the root of the documentation.
155-
#html_extra_path = []
154+
#html_extra_path = []
156155

157156
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
158157
# using the given strftime format.
159-
#html_last_updated_fmt = '%b %d, %Y'
158+
#html_last_updated_fmt = '%b %d, %Y'
160159

161160
# If true, SmartyPants will be used to convert quotes and dashes to
162161
# typographically correct entities.
163-
#html_use_smartypants = True
162+
#html_use_smartypants = True
164163

165164
# Custom sidebar templates, maps document names to template names.
166-
#html_sidebars = {}
165+
#html_sidebars = {}
167166

168167
# Additional templates that should be rendered to pages, maps page names to
169168
# template names.
170-
#html_additional_pages = {}
169+
#html_additional_pages = {}
171170

172171
# If false, no module index is generated.
173-
#html_domain_indices = True
172+
#html_domain_indices = True
174173

175174
# If false, no index is generated.
176-
#html_use_index = True
175+
#html_use_index = True
177176

178177
# If true, the index is split into individual pages for each letter.
179-
#html_split_index = False
178+
#html_split_index = False
180179

181180
# If true, links to the reST sources are added to the pages.
182-
#html_show_sourcelink = True
181+
#html_show_sourcelink = True
183182

184183
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
185-
#html_show_sphinx = True
184+
#html_show_sphinx = True
186185

187186
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
188-
#html_show_copyright = True
187+
#html_show_copyright = True
189188

190189
# If true, an OpenSearch description file will be output, and all pages will
191190
# contain a <link> tag referring to it. The value of this option must be the
192191
# base URL from which the finished HTML is served.
193-
#html_use_opensearch = ''
192+
#html_use_opensearch = ''
194193

195194
# This is the file name suffix for HTML files (e.g. ".xhtml").
196-
#html_file_suffix = None
195+
#html_file_suffix = None
197196

198197
# Output file base name for HTML help builder.
199-
htmlhelp_basename='python-gitlabdoc'
198+
htmlhelp_basename="python-gitlabdoc"
200199

201200

202201
# -- Options for LaTeX output ---------------------------------------------
203202

204203
latex_elements= {
205-
# The paper size ('letterpaper' or 'a4paper').
206-
#'papersize': 'letterpaper',
207-
208-
# The font size ('10pt', '11pt' or '12pt').
209-
#'pointsize': '10pt',
210-
211-
# Additional stuff for the LaTeX preamble.
212-
#'preamble': '',
204+
# The paper size ('letterpaper' or 'a4paper').
205+
#'papersize': 'letterpaper',
206+
# The font size ('10pt', '11pt' or '12pt').
207+
#'pointsize': '10pt',
208+
# Additional stuff for the LaTeX preamble.
209+
#'preamble': '',
213210
}
214211

215212
# Grouping the document tree into LaTeX files. List of tuples
216213
# (source start file, target name, title,
217214
# author, documentclass [howto, manual, or own class]).
218215
latex_documents= [
219-
('index','python-gitlab.tex','python-gitlab Documentation',
220-
'Gauvain Pocentek, Mika Mäenpää','manual'),
216+
(
217+
"index",
218+
"python-gitlab.tex",
219+
"python-gitlab Documentation",
220+
"Gauvain Pocentek, Mika Mäenpää",
221+
"manual",
222+
)
221223
]
222224

223225
# The name of an image file (relative to this directory) to place at the top of
224226
# the title page.
225-
#latex_logo = None
227+
#latex_logo = None
226228

227229
# For "manual" documents, if this is true, then toplevel headings are parts,
228230
# not chapters.
229-
#latex_use_parts = False
231+
#latex_use_parts = False
230232

231233
# If true, show page references after internal links.
232-
#latex_show_pagerefs = False
234+
#latex_show_pagerefs = False
233235

234236
# If true, show URL addresses after external links.
235-
#latex_show_urls = False
237+
#latex_show_urls = False
236238

237239
# Documents to append as an appendix to all manuals.
238-
#latex_appendices = []
240+
#latex_appendices = []
239241

240242
# If false, no module index is generated.
241-
#latex_domain_indices = True
243+
#latex_domain_indices = True
242244

243245

244246
# -- Options for manual page output ---------------------------------------
245247

246248
# One entry per manual page. List of tuples
247249
# (source start file, name, description, authors, manual section).
248250
man_pages= [
249-
('index','python-gitlab','python-gitlab Documentation',
250-
['Gauvain Pocentek, Mika Mäenpää'],1)
251+
(
252+
"index",
253+
"python-gitlab",
254+
"python-gitlab Documentation",
255+
["Gauvain Pocentek, Mika Mäenpää"],
256+
1,
257+
)
251258
]
252259

253260
# If true, show URL addresses after external links.
254-
#man_show_urls = False
261+
#man_show_urls = False
255262

256263

257264
# -- Options for Texinfo output -------------------------------------------
@@ -260,20 +267,25 @@
260267
# (source start file, target name, title, author,
261268
# dir menu entry, description, category)
262269
texinfo_documents= [
263-
('index','python-gitlab','python-gitlab Documentation',
264-
'Gauvain Pocentek, Mika Mäenpää','python-gitlab','One line description of project.',
265-
'Miscellaneous'),
270+
(
271+
"index",
272+
"python-gitlab",
273+
"python-gitlab Documentation",
274+
"Gauvain Pocentek, Mika Mäenpää",
275+
"python-gitlab",
276+
"One line description of project.",
277+
"Miscellaneous",
278+
)
266279
]
267280

268281
# Documents to append as an appendix to all manuals.
269-
#texinfo_appendices = []
282+
#texinfo_appendices = []
270283

271284
# If false, no module index is generated.
272-
#texinfo_domain_indices = True
285+
#texinfo_domain_indices = True
273286

274287
# How to display URL addresses: 'footnote', 'no', or 'inline'.
275-
#texinfo_show_urls = 'footnote'
288+
#texinfo_show_urls = 'footnote'
276289

277290
# If true, do not generate a @detailmenu in the "Top" node's menu.
278-
#texinfo_no_detailmenu = False
279-
291+
# texinfo_no_detailmenu = False

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp