Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare template documents for furo style docs #1131

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Prepare template documents for furo style docs

a94a054
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Open

Prepare template documents for furo style docs #1131

Prepare template documents for furo style docs
a94a054
Select commit
Loading
Failed to load commit list.
GitHub Actions / Black failed Nov 8, 2024 in 0s

3 errors

Black found 3 errors

Annotations

Check failure on line 76 in /home/runner/work/oemof-solph/oemof-solph/docs/conf.py

See this annotation in the file changed.

@github-actions github-actions / Black

/home/runner/work/oemof-solph/oemof-solph/docs/conf.py#L16-L76

     # Register a sphinx.ext.autodoc.between listener to ignore everything
     # between lines that contain the word IGNORE
     app.connect("autodoc-process-docstring", between("^SPDX.*$", exclude=True))
     return app
 
+
 # -- General configuration ------------------------------------------------
 
 # 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.ext.autosummary',
-    'sphinx.ext.coverage',
-    'sphinx.ext.doctest',
-    'sphinx.ext.extlinks',
-    'sphinx.ext.ifconfig',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
-    'sphinx_copybutton',
-    'sphinx_design',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.coverage",
+    "sphinx.ext.doctest",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx_copybutton",
+    "sphinx_design",
 ]
 
 # landing page
 # master_doc = 'contents'
 # names, years, etc
-project = 'oemof.solph'
-year = '2024'
-author = 'oemof developer group'
-copyright = '{0}, {1}'.format(year, author)
+project = "oemof.solph"
+year = "2024"
+author = "oemof developer group"
+copyright = "{0}, {1}".format(year, author)
 
 # The short X.Y version.
-version = oemof.solph.__version__.split(' ')[0]
+version = oemof.solph.__version__.split(" ")[0]
 # The full version, including alpha/beta/rc tags.
 release = oemof.solph.__version__
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 # folder for templates
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 # pygments_style = "some"
 # pygments_dark_style = "someother"
 
 # show all class members
 # numpydoc_show_class_members = False
 
 # place for bibtex references
-bibtex_bibfiles = ['references.bib']
+bibtex_bibfiles = ["references.bib"]
 
 # links to github
 github_repo_url = "https://github.com/oemof/oemof-solph/"
 extlinks = {
     "issue": (f"{github_repo_url}/issues/%s", "#%s"),  # noqa: WPS323

Check failure on line 127 in /home/runner/work/oemof-solph/oemof-solph/docs/conf.py

See this annotation in the file changed.

@github-actions github-actions / Black

/home/runner/work/oemof-solph/oemof-solph/docs/conf.py#L78-L127

 }
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.
-html_theme = 'furo'
+html_theme = "furo"
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-html_short_title = '%s-%s' % (project, version)
+html_short_title = "%s-%s" % (project, version)
 
 # Some more stuff
 html_use_smartypants = True
-html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = "%b %d, %Y"
 html_split_index = False
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # 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_css_files = [
-    'css/custom.css',
+    "css/custom.css",
 ]
 # html_additional_pages = {
 #     "index": "index.html"
 # }
 
 html_sidebars = {
-    '**': [
-        'sidebar/brand.html',
-        'sidebar/search.html',
-        'sidebar/scroll-start.html',
-        'sidebar/navigation.html',
-        'sidebar/ethical-ads.html',
-        'sidebar/scroll-end.html',
-        'sidebar/variant-selector.html',
+    "**": [
+        "sidebar/brand.html",
+        "sidebar/search.html",
+        "sidebar/scroll-start.html",
+        "sidebar/navigation.html",
+        "sidebar/ethical-ads.html",
+        "sidebar/scroll-end.html",
+        "sidebar/variant-selector.html",
     ],
 }
 
 html_theme_options = {
     "light_logo": "./_logo/logo_oemof_solph_COMPACT.svg",

Check failure on line 155 in /home/runner/work/oemof-solph/oemof-solph/docs/conf.py

See this annotation in the file changed.

@github-actions github-actions / Black

/home/runner/work/oemof-solph/oemof-solph/docs/conf.py#L129-L155

     <div oemof-announcement=\"https://raw.githubusercontent.com/oemof/oemof-solph/announcements/announcement.html\"></div>
     """,
 }
 
 html_js_files = [
-    'js/custom.js',
+    "js/custom.js",
 ]
 
 
-html_favicon = './_static/_logo/logo_oemof_solph_ICON.svg'
+html_favicon = "./_static/_logo/logo_oemof_solph_ICON.svg"
 
 napoleon_use_ivar = True
 napoleon_use_rtype = False
 napoleon_use_param = False
 
 # copybutton configuration
-copybutton_prompt_text = r'>>> |\.\.\. '
+copybutton_prompt_text = r">>> |\.\.\. "
 copybutton_prompt_is_regexp = True
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'oemof.solph_doc'
+htmlhelp_basename = "oemof.solph_doc"
 
 linkcheck_ignore = [
     r"https://requires.io/.*",
     r"https://matrix.to/*",
     r"https://forum.openmod-initiative.org/*",