Skip to content

Commit

Permalink
lint fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
thht committed Sep 20, 2024
1 parent 756d681 commit b524f7b
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 27 deletions.
52 changes: 26 additions & 26 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

import pyrasa
from sphinx.config import is_serializable

import pyrasa

project = 'PyRASA'
copyright = '2024, Fabian Schmidt, Thomas Hartmann'
author = 'Fabian Schmidt, Thomas Hartmann'
Expand All @@ -29,7 +30,7 @@
templates_path = ['_templates']
exclude_patterns = []

source_suffix = [".rst", ".md"]
source_suffix = ['.rst', '.md']

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand All @@ -41,45 +42,44 @@
release = version



# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "pydata_sphinx_theme"
html_theme = 'pydata_sphinx_theme'
html_static_path = ['_static']

switcher_version_match = "dev" if "dev" in release else version
switcher_version_match = 'dev' if 'dev' in release else version

html_theme_options = {
"icon_links": [
'icon_links': [
dict(
name="GitHub",
url="https://github.com/schmidtfa/pyrasa",
icon="fab fa-github-square",
name='GitHub',
url='https://github.com/schmidtfa/pyrasa',
icon='fab fa-github-square',
),
],
"icon_links_label": "Quick Links", # for screen reader
"use_edit_page_button": False,
"navigation_with_keys": False,
"show_toc_level": 1,
"header_links_before_dropdown": 6,
"navbar_end": ["theme-switcher", "version-switcher", "navbar-icon-links"],
"switcher": {
"json_url": "https://raw.githubusercontent.com/mne-tools/mne-bids/main/doc/_static/versions.json", # noqa: E501
"version_match": switcher_version_match,
'icon_links_label': 'Quick Links', # for screen reader
'use_edit_page_button': False,
'navigation_with_keys': False,
'show_toc_level': 1,
'header_links_before_dropdown': 6,
'navbar_end': ['theme-switcher', 'version-switcher', 'navbar-icon-links'],
'switcher': {
'json_url': 'https://raw.githubusercontent.com/mne-tools/mne-bids/main/doc/_static/versions.json', # noqa: E501
'version_match': switcher_version_match,
},
}

sphinx_gallery_conf = {
"doc_module": "pyrasa",
"reference_url": {
"pyrasa": None,
'doc_module': 'pyrasa',
'reference_url': {
'pyrasa': None,
},
"backreferences_dir": "generated",
"examples_dirs": "../../examples",
"within_subsection_order": "ExampleTitleSortKey",
"gallery_dirs": "auto_examples",
"filename_pattern": "^((?!sgskip).)*$",
'backreferences_dir': 'generated',
'examples_dirs': '../../examples',
'within_subsection_order': 'ExampleTitleSortKey',
'gallery_dirs': 'auto_examples',
'filename_pattern': '^((?!sgskip).)*$',
}

assert is_serializable(sphinx_gallery_conf)
2 changes: 1 addition & 1 deletion pyrasa/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""IRASA Core Functions."""

from pyrasa.irasa import irasa, irasa_sprint
from pyrasa.__version__ import __version__
from pyrasa.irasa import irasa, irasa_sprint

__all__ = ['irasa', 'irasa_sprint', '__version__']

0 comments on commit b524f7b

Please sign in to comment.