Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
786246e
ruff rules
fsoubelet Jul 11, 2025
8ea0377
formatting
fsoubelet Jul 11, 2025
2079a30
simple automated fixes
fsoubelet Jul 11, 2025
5e6c636
use dict literals
fsoubelet Jul 11, 2025
4a1980e
no need for .key to iterate dict
fsoubelet Jul 11, 2025
d7bc113
do not assign to variables that will be unused
fsoubelet Jul 11, 2025
37fb869
no positional-only boolean arguments
fsoubelet Jul 11, 2025
5be677a
unecessary comprehension
fsoubelet Jul 11, 2025
bd2dc20
do not do exact comparison for types, use is
fsoubelet Jul 11, 2025
6663f47
combine with statements
fsoubelet Jul 11, 2025
a74dd8f
noqa this one
fsoubelet Jul 11, 2025
990e836
open devnull with context manager, do not close finally
fsoubelet Jul 11, 2025
354c43e
combine with statements
fsoubelet Jul 11, 2025
39499d9
no ambiguous variable name
fsoubelet Jul 11, 2025
b82e234
no need to call class and self in super() call
fsoubelet Jul 11, 2025
d8d2303
noqa this one
fsoubelet Jul 11, 2025
cb3917c
unecessary comprehension and use of |
fsoubelet Jul 11, 2025
a6e88c1
dont use not, unequal comparison directly
fsoubelet Jul 11, 2025
e8527fb
prefer ternary operator to if-else checks
fsoubelet Jul 11, 2025
c9078cf
first arg of classmethod is cls
fsoubelet Jul 11, 2025
e51ce36
unecessary generator
fsoubelet Jul 11, 2025
49fad6c
use |
fsoubelet Jul 11, 2025
dceab52
give language, replace deprecated option, remove unnecessary line
fsoubelet Jul 11, 2025
f41437a
use pathlib operations where possible
fsoubelet Jul 11, 2025
16e13a2
review comments
fsoubelet Jul 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
#
# Generic-Parser documentation build configuration file, created by
# sphinx-quickstart on Tue Feb 6 12:10:18 2018.
Expand All @@ -16,7 +15,6 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import pathlib
import sys

Expand All @@ -28,9 +26,6 @@
warnings.filterwarnings("ignore", message="numpy.ufunc size changed")


sys.path.insert(0, os.path.abspath("../"))


TOPLEVEL_DIR = pathlib.Path(__file__).parent.parent.absolute()
ABOUT_FILE = TOPLEVEL_DIR / "generic_parser" / "__init__.py"

Expand Down Expand Up @@ -104,7 +99,7 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand All @@ -126,14 +121,14 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
html_theme = "sphinx_rtd_theme"

html_theme_options = {
'collapse_navigation': False,
'display_version': True,
'logo_only': True,
'navigation_depth': 2,
"collapse_navigation": False,
"version_selector": True, # sphinx-rtd-theme>=3.0, formerly 'display_version'
"logo_only": True,
"navigation_depth": 2,
}

html_logo = '_static/img/omc_logo.svg'
html_static_path = ['_static']
html_logo = "_static/img/omc_logo.svg"
html_static_path = ["_static"]
html_css_files = ["css/custom.css"]

smartquotes_action = "qe" # renders only quotes and ellipses (...) but not dashes (option: D)
Expand Down Expand Up @@ -189,15 +184,15 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, "generic-parser.tex", u"generic-parser Documentation", u"OMC-TEAM", "manual"),
(master_doc, "generic-parser.tex", "generic-parser Documentation", "OMC-TEAM", "manual"),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "generic-parser", u"Generic-Parser Documentation", [author], 1)]
man_pages = [(master_doc, "generic-parser", "Generic-Parser Documentation", [author], 1)]


# -- Options for Texinfo output -------------------------------------------
Expand All @@ -209,7 +204,7 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
(
master_doc,
"generic-parser",
u"generic-parser Documentation",
"generic-parser Documentation",
author,
"OMC-TEAM",
"One line description of project.",
Expand Down
Loading
Loading