From 6575955a3553b3cb41908bb9a89abd2330593e43 Mon Sep 17 00:00:00 2001 From: chris-s-friedman Date: Thu, 30 May 2024 08:59:33 -0400 Subject: [PATCH 1/3] =?UTF-8?q?=F0=9F=9A=A8=20Make=20conf.py=20meet=20blac?= =?UTF-8?q?k=20formatting?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/conf.py | 71 ++++++++++++++++++++++++++------------------- 1 file changed, 41 insertions(+), 30 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 13ce5e22..a84e8098 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,14 +19,14 @@ # -- Project information ----------------------------------------------------- -project = 'Kids First Data Ingest Libraries' -copyright = '2019, Kids First' -author = 'Kids First' +project = "Kids First Data Ingest Libraries" +copyright = "2019, Kids First" +author = "Kids First" # The short X.Y version -version = '0.0.1' +version = "0.0.1" # The full version, including alpha/beta/rc tags -release = '' +release = "" # -- General configuration --------------------------------------------------- @@ -39,22 +39,22 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', - 'sphinx.ext.githubpages' + "sphinx.ext.autodoc", + "sphinx.ext.viewcode", + "sphinx.ext.githubpages", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -78,24 +78,22 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_kidsfirst_theme' +html_theme = "sphinx_kidsfirst_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # -html_theme_options = { - 'logo_only': True -} +html_theme_options = {"logo_only": True} # 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 = ["_static"] -html_logo = '_static/images/logo.png' +html_logo = "_static/images/logo.png" html_css_files = [ - 'other.css', + "other.css", ] @@ -113,7 +111,7 @@ # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'KidsFirstDataIngestLibrariesdoc' +htmlhelp_basename = "KidsFirstDataIngestLibrariesdoc" # -- Options for LaTeX output ------------------------------------------------ @@ -122,15 +120,12 @@ # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. # # 'preamble': '', - # Latex figure (float) alignment # # 'figure_align': 'htbp', @@ -140,8 +135,13 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'KidsFirstDataIngestLibraries.tex', 'Kids First Data Ingest Libraries Documentation', - 'Kids First DRC, Natasha Singh, Avi Kelman', 'manual'), + ( + master_doc, + "KidsFirstDataIngestLibraries.tex", + "Kids First Data Ingest Libraries Documentation", + "Kids First DRC, Natasha Singh, Avi Kelman", + "manual", + ), ] @@ -150,8 +150,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'kidsfirstdataingestlibraries', 'Kids First Data Ingest Libraries Documentation', - [author], 1) + ( + master_doc, + "kidsfirstdataingestlibraries", + "Kids First Data Ingest Libraries Documentation", + [author], + 1, + ) ] @@ -161,9 +166,15 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'KidsFirstDataIngestLibraries', 'Kids First Data Ingest Libraries Documentation', - author, 'KidsFirstDataIngestLibraries', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "KidsFirstDataIngestLibraries", + "Kids First Data Ingest Libraries Documentation", + author, + "KidsFirstDataIngestLibraries", + "One line description of project.", + "Miscellaneous", + ), ] @@ -182,7 +193,7 @@ # epub_uid = '' # A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] +epub_exclude_files = ["search.html"] # -- Extension configuration ------------------------------------------------- From ceea4184531ed858e4cc05bf1f88599b801a091c Mon Sep 17 00:00:00 2001 From: chris-s-friedman Date: Thu, 30 May 2024 08:59:55 -0400 Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=94=A7=20Update=20docs=20site=20copyr?= =?UTF-8?q?ight?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index a84e8098..4d28104f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- project = "Kids First Data Ingest Libraries" -copyright = "2019, Kids First" +copyright = "2024, Kids First" author = "Kids First" # The short X.Y version From ee8b9502fc4fa518547f6fd794cacdadd4f10fb1 Mon Sep 17 00:00:00 2001 From: chris-s-friedman Date: Thu, 30 May 2024 09:05:44 -0400 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=93=8C=20Pin=20sphinx=20to=20last=20r?= =?UTF-8?q?elease=20of=20sphinx=20v6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit sphinx 7 removes support for the `style` html key used in sphinx-rtd version that is pinned in kf-sphinx-rtd theme. see https://www.sphinx-doc.org/en/master/changes.html#release-7-0-0-released-apr-29-2023 --- doc-requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-requirements.txt b/doc-requirements.txt index b7b2566c..1995ac07 100644 --- a/doc-requirements.txt +++ b/doc-requirements.txt @@ -1,3 +1,3 @@ -sphinx>=1.8.2 +sphinx==6.2.1 doc8>=0.8.0 sphinx_kidsfirst_theme @ git+https://github.com/kids-first/kf-sphinx-docs-theme.git