summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Vatamaniuc <vatamane@gmail.com>2022-10-14 22:48:56 -0400
committerNick Vatamaniuc <nickva@users.noreply.github.com>2022-10-17 14:21:37 -0400
commit15ec5dcac9fc6d21b1efc691cf69488592dc5180 (patch)
tree3df8d662709d543ae9624bbc69c6a48b452fd62e
parent3d04161d8fbc9ee4fc274d50ee4f0d064c9f08ec (diff)
downloadcouchdb-15ec5dcac9fc6d21b1efc691cf69488592dc5180.tar.gz
Reformat src/docs/src/conf.py
After a recent change [1], python black started to complain. Since we updated docs only in that PR we skipped the python black check. So reformat to make the checker happy. In the future make sure to run python black formatting even when we make docs-only changes. [1] https://github.com/apache/couchdb/pull/4208
-rw-r--r--build-aux/Jenkinsfile.pr3
-rw-r--r--src/docs/src/conf.py2
2 files changed, 4 insertions, 1 deletions
diff --git a/build-aux/Jenkinsfile.pr b/build-aux/Jenkinsfile.pr
index 1c3dc2f1e..f24fed1a8 100644
--- a/build-aux/Jenkinsfile.pr
+++ b/build-aux/Jenkinsfile.pr
@@ -117,6 +117,9 @@ pipeline {
}
steps {
sh '''
+ make python-black
+ '''
+ sh '''
(cd src/docs && make check)
'''
}
diff --git a/src/docs/src/conf.py b/src/docs/src/conf.py
index c6c583a07..05d3a4258 100644
--- a/src/docs/src/conf.py
+++ b/src/docs/src/conf.py
@@ -77,7 +77,7 @@ html_context = {
"rtd_ver": os.environ.get("READTHEDOCS_VERSION_NAME") or "latest",
}
-http_index_shortname = 'API Reference'
+http_index_shortname = "API Reference"
http_index_localname = "API Quick Reference"