Skip to content

Commit

Permalink
docs: fix Sphinx workflow #239
Browse files Browse the repository at this point in the history
- Migrate to Sphinx 6
- Update to sphinx-autoapi 3.0.0
- Migrate to newer version of sphinx-book-theme
- Remove sphinx-click as we move away from Click framework
  • Loading branch information
poikilotherm committed Jan 11, 2024
1 parent 00cd6c4 commit 65dcfcd
Show file tree
Hide file tree
Showing 4 changed files with 140 additions and 117 deletions.
13 changes: 13 additions & 0 deletions docs/source/_templates/funding.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!--
SPDX-FileCopyrightText: 2024 Forschungszentrum Jülich
SPDX-License-Identifier: CC0-1.0
SPDX-FileContributor: Oliver Bertuch
-->
<div class="funding">
Funded by the <i>Initiative and Networking Fund</i> of the
<a href='https://www.helmholtz.de/en/about-us/structure-and-governance/initiating-and-networking/' target='_blank'>
Helmholtz Association
</a>
in the framework of the
<a href='https://helmholtz-metadaten.de' targe='_blank'>Helmholtz Metadata Collaboration</a>
</div>
21 changes: 10 additions & 11 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
# -- Project information -----------------------------------------------------

project = 'HERMES Workflow'
copyright = '2022, HERMES project'
copyright = '2024, HERMES project'
author = 'Oliver Bertuch, Stephan Druskat, Guido Juckeland, Jeffrey Kelling, ' + \
'Oliver Knodel, Michael Meinel, Tobias Schlauch, Sophie Kernchen'


# The full version, including alpha/beta/rc tags
release = '2022-07-01'
release = '2024-01-11'


# -- General configuration ---------------------------------------------------
Expand All @@ -57,7 +57,6 @@
"sphinxext.opengraph",
'myst_parser',
'autoapi.extension',
'sphinx_click',
'sphinxcontrib.mermaid',
'sphinx_togglebutton',
]
Expand Down Expand Up @@ -102,11 +101,11 @@
html_static_path = ['_static']

html_logo = '_static/img/hermes-visual-blue.svg'
html_title = 'Workflow Docs'
html_title = 'HERMES Documentation'

# Custom sidebar templates, maps document names to template names.
html_sidebars = {
"**": ["sidebar-logo.html", "sbt-sidebar-nav.html"]
"**": ["navbar-logo.html", "sbt-sidebar-nav.html", "funding.html"]
}

# Enable and customize the permanent headerlinks with a nice icon (chain symbol from FontAwesome)
Expand All @@ -115,19 +114,19 @@

html_theme_options = {
"home_page_in_toc": True,
"extra_navbar": "<div>Funded by the <i>Initiative and Networking Fund</i> of the <a \
href='https://www.helmholtz.de/en/about-us/structure-and-governance/initiating-and-networking/' \
target='_blank'>Helmholtz Association</a> in the framework of the \
<a href='https://helmholtz-metadaten.de' targe='_blank'>Helmholtz Metadata \
Collaboration</a></div>",
"repository_url": "https://github.com/hermes-hmc/workflow",
"repository_url": "https://github.com/hermes-hmc/hermes",
"use_repository_button": True,
"navigation_with_keys": False,
}

html_css_files = [
'custom.css',
]

html_context = {
"default_mode": "light",
}

# -- Options for OpenGraph Tags ----------------------------------------------

ogp_site_url = "https://docs.software-metadata.pub/"
Expand Down
Loading

0 comments on commit 65dcfcd

Please sign in to comment.