Loading Makefile +1 −1 Original line number Diff line number Diff line Loading @@ -14,7 +14,7 @@ help: # re-format python files, # use local maximum line-length convention .. black: black --line-length=99 py black --line-length=99 py doc/source/conf.py # generate documentation: docu: Loading doc/source/conf.py +17 −19 Original line number Diff line number Diff line Loading @@ -12,17 +12,18 @@ # import os import sys sys.path.insert(0, os.path.abspath(os.path.join(os.pardir,os.pardir,'py')) ) sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "py"))) # -- Project information ----------------------------------------------------- project = 'CSO' copyright = '2020-2023, Arjo Segers' author = 'Arjo Segers' project = "CSO" copyright = "2020-2023, Arjo Segers" author = "Arjo Segers" # The full version, including alpha/beta/rc tags release = 'v2.6.1' release = "v2.6.1" # -- General configuration --------------------------------------------------- Loading @@ -31,13 +32,13 @@ release = 'v2.6.1' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.mathjax", ] # Add any paths that contain templates here, relative to this directory. 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. Loading @@ -53,12 +54,9 @@ exclude_patterns = [] # * 'show-inheritance' : name of base class; # * 'members' : members of modules (classes) and classes (methods); # * 'inherited-members' : inherited members: autodoc_default_options = { 'members' : True, 'show-inheritance' : True } autodoc_default_options = {"members": True, "show-inheritance": True} # do not sort methods alphabetically, keep source order: autodoc_member_order = 'bysource' autodoc_member_order = "bysource" # ~~ options for intersphinx Loading @@ -66,8 +64,8 @@ autodoc_member_order = 'bysource' # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html # add links to existing online documentation if present: docs_url = 'https://docs.python.org/%i.%i' % (sys.version_info.major,sys.version_info.minor) intersphinx_mapping = { 'python' : (docs_url,None) } docs_url = "https://docs.python.org/%i.%i" % (sys.version_info.major, sys.version_info.minor) intersphinx_mapping = {"python": (docs_url, None)} # -- Options for HTML output ------------------------------------------------- Loading @@ -75,7 +73,7 @@ intersphinx_mapping = { 'python' : (docs_url,None) } # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'bizstyle' html_theme = "bizstyle" # 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, Loading @@ -89,4 +87,4 @@ html_static_path = [] # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/3/': None} intersphinx_mapping = {"https://docs.python.org/3/": None} Loading
Makefile +1 −1 Original line number Diff line number Diff line Loading @@ -14,7 +14,7 @@ help: # re-format python files, # use local maximum line-length convention .. black: black --line-length=99 py black --line-length=99 py doc/source/conf.py # generate documentation: docu: Loading
doc/source/conf.py +17 −19 Original line number Diff line number Diff line Loading @@ -12,17 +12,18 @@ # import os import sys sys.path.insert(0, os.path.abspath(os.path.join(os.pardir,os.pardir,'py')) ) sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "py"))) # -- Project information ----------------------------------------------------- project = 'CSO' copyright = '2020-2023, Arjo Segers' author = 'Arjo Segers' project = "CSO" copyright = "2020-2023, Arjo Segers" author = "Arjo Segers" # The full version, including alpha/beta/rc tags release = 'v2.6.1' release = "v2.6.1" # -- General configuration --------------------------------------------------- Loading @@ -31,13 +32,13 @@ release = 'v2.6.1' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.mathjax", ] # Add any paths that contain templates here, relative to this directory. 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. Loading @@ -53,12 +54,9 @@ exclude_patterns = [] # * 'show-inheritance' : name of base class; # * 'members' : members of modules (classes) and classes (methods); # * 'inherited-members' : inherited members: autodoc_default_options = { 'members' : True, 'show-inheritance' : True } autodoc_default_options = {"members": True, "show-inheritance": True} # do not sort methods alphabetically, keep source order: autodoc_member_order = 'bysource' autodoc_member_order = "bysource" # ~~ options for intersphinx Loading @@ -66,8 +64,8 @@ autodoc_member_order = 'bysource' # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html # add links to existing online documentation if present: docs_url = 'https://docs.python.org/%i.%i' % (sys.version_info.major,sys.version_info.minor) intersphinx_mapping = { 'python' : (docs_url,None) } docs_url = "https://docs.python.org/%i.%i" % (sys.version_info.major, sys.version_info.minor) intersphinx_mapping = {"python": (docs_url, None)} # -- Options for HTML output ------------------------------------------------- Loading @@ -75,7 +73,7 @@ intersphinx_mapping = { 'python' : (docs_url,None) } # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'bizstyle' html_theme = "bizstyle" # 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, Loading @@ -89,4 +87,4 @@ html_static_path = [] # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/3/': None} intersphinx_mapping = {"https://docs.python.org/3/": None}