jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/463954 )
Change subject: [cleanup] cleanup docs/conf.py ......................................................................
[cleanup] cleanup docs/conf.py
- remove preleading "u" from strings - make sure lines do not exceed 79 chars
Bug: T89589 Change-Id: I6f80256592df6281b5e267d4980bd864049bb771 --- M docs/conf.py 1 file changed, 17 insertions(+), 15 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/docs/conf.py b/docs/conf.py index c78193d..079af53 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,13 +30,13 @@ sys.path.insert(0, repo_dir) os.chdir(repo_dir)
-# -- General configuration ----------------------------------------------------- +# -- General configuration ----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0'
-# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx_epytext', 'sphinx.ext.todo', @@ -87,7 +87,8 @@ # directories to ignore when looking for source files. exclude_patterns = ['_build']
-# The reST default role (used for this markup: `text`) to use for all documents. +# The reST default role (used for this markup: `text`) to use for all +# documents. default_role = 'code'
# If true, '()' will be appended to :func: etc. cross-reference text. @@ -108,7 +109,7 @@ # modindex_common_prefix = []
-# -- Options for HTML output --------------------------------------------------- +# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. @@ -188,15 +189,16 @@ htmlhelp_basename = 'Pywikibotdoc'
-# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output -------------------------------------------------
latex_elements = {}
# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). +# (source start file, target name, title, author, documentclass +# [howto/manual]). latex_documents = [ - ('index', 'Pywikibot.tex', u'Pywikibot Documentation', - u'Pywikibot team', 'manual'), + ('index', 'Pywikibot.tex', 'Pywikibot Documentation', + 'Pywikibot team', 'manual'), ]
# The name of an image file (relative to this directory) to place at the top of @@ -220,27 +222,27 @@ # latex_domain_indices = True
-# -- Options for manual page output -------------------------------------------- +# -- Options for manual page output -------------------------------------------
# One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'pywikibot', u'Pywikibot Documentation', - [u'Pywikibot team'], 1) + ('index', 'pywikibot', 'Pywikibot Documentation', + ['Pywikibot team'], 1) ]
# If true, show URL addresses after external links. # man_show_urls = False
-# -- Options for Texinfo output ------------------------------------------------ +# -- Options for Texinfo output -----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'Pywikibot', u'Pywikibot Documentation', - u'Pywikibot team', 'Pywikibot', 'One line description of project.', + ('index', 'Pywikibot', 'Pywikibot Documentation', + 'Pywikibot team', 'Pywikibot', 'One line description of project.', 'Miscellaneous'), ]