This is an automated email from the ASF dual-hosted git repository.
astitcher pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-proton.git
The following commit(s) were added to refs/heads/main by this push:
new 36257ed44 NO-JIRA: Fix small formatting issues picked up by flake8
36257ed44 is described below
commit 36257ed442dcdd6723452a4b2a89f49e5c4fadce
Author: Andrew Stitcher <[email protected]>
AuthorDate: Wed Jan 8 11:10:19 2025 -0500
NO-JIRA: Fix small formatting issues picked up by flake8
---
python/docs/conf.py | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/python/docs/conf.py b/python/docs/conf.py
index 0eeb5a8f4..49c8a33c8 100644
--- a/python/docs/conf.py
+++ b/python/docs/conf.py
@@ -31,8 +31,9 @@ try:
ver_file_path = os.path.abspath('../../VERSION.txt')
with open(ver_file_path, 'r') as ver_file:
ver_str = ver_file.read().replace('\n', '')
+ # Strip '-SNAPSHOT' from end of string
if '-' in ver_str:
- version = ver_str.split("-")[0] # Strip '-SNAPSHOT' from end of
string
+ version = ver_str.split("-")[0]
else:
version = ver_str
release = version
@@ -53,7 +54,8 @@ except IOError:
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
- 'sphinx.ext.mathjax', # needed for math formulas on some versions of
Sphinx
+ # needed for math formulas on some versions of Sphinx
+ 'sphinx.ext.mathjax'
]
# Add any paths that contain templates here, relative to this directory.
@@ -73,7 +75,7 @@ master_doc = 'index'
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
-#language = None
+# language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
@@ -100,7 +102,7 @@ html_theme = 'sphinxdoc'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
+# html_static_path = []
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
@@ -143,7 +145,9 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'QpidProtonPythonAPI.tex', 'Qpid Proton Python API
Documentation',
+ (master_doc,
+ 'QpidProtonPythonAPI.tex',
+ 'Qpid Proton Python API Documentation',
'Apache Qpid Contributors', 'manual'),
]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
