Skip to content

Commit 9267564

Browse files
authored
Linter configuration and fixes (#60)
1 parent 65cfc69 commit 9267564

File tree

10 files changed

+574
-423
lines changed

10 files changed

+574
-423
lines changed

doc/conf.py

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# -*- coding: utf-8 -*-
21
#
32
# Generic-Parser documentation build configuration file, created by
43
# sphinx-quickstart on Tue Feb 6 12:10:18 2018.
@@ -16,7 +15,6 @@
1615
# add these directories to sys.path here. If the directory is relative to the
1716
# documentation root, use os.path.abspath to make it absolute, like shown here.
1817
#
19-
import os
2018
import pathlib
2119
import sys
2220

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

3028

31-
sys.path.insert(0, os.path.abspath("../"))
32-
33-
3429
TOPLEVEL_DIR = pathlib.Path(__file__).parent.parent.absolute()
3530
ABOUT_FILE = TOPLEVEL_DIR / "generic_parser" / "__init__.py"
3631

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

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

128123
html_theme_options = {
129-
'collapse_navigation': False,
130-
'display_version': True,
131-
'logo_only': True,
132-
'navigation_depth': 2,
124+
"collapse_navigation": False,
125+
"version_selector": True, # sphinx-rtd-theme>=3.0, formerly 'display_version'
126+
"logo_only": True,
127+
"navigation_depth": 2,
133128
}
134129

135-
html_logo = '_static/img/omc_logo.svg'
136-
html_static_path = ['_static']
130+
html_logo = "_static/img/omc_logo.svg"
131+
html_static_path = ["_static"]
137132
html_css_files = ["css/custom.css"]
138133

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

195190

196191
# -- Options for manual page output ---------------------------------------
197192

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

202197

203198
# -- Options for Texinfo output -------------------------------------------
@@ -209,7 +204,7 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
209204
(
210205
master_doc,
211206
"generic-parser",
212-
u"generic-parser Documentation",
207+
"generic-parser Documentation",
213208
author,
214209
"OMC-TEAM",
215210
"One line description of project.",

0 commit comments

Comments
 (0)