diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 5a8722f..339ded2 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,13 +1,14 @@ Change Log ========== -[dev] ------ +[1.2] - 2021-04-04 +------------------ - [ADDED] Landing page with vuepress. - [ADDED] Conda-forge recipe. - [ADDED] Function `SOMClassifier.predict_proba()` - [ADDED] Example notebook for multi-output regression - [CHANGED] Code formatting to black. +- [CHANGED] CI from travis to GitHub actions. - [FIXED] Requirements in setup.py [1.1.2] - 2021-02-18 diff --git a/docs/conf.py b/docs/conf.py index 816ee6c..94b04dd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,19 +14,20 @@ # import os import sys -sys.path.insert(0, os.path.abspath('../')) + +sys.path.insert(0, os.path.abspath("../")) # -- Project information ----------------------------------------------------- -project = 'SuSi' -copyright = '2019-2021 Felix M. Riese' -author = 'Felix M. Riese' +project = "SuSi" +copyright = "2019-2021 Felix M. Riese" +author = "Felix M. Riese" # The short X.Y version -version = '' +version = "" # The full version, including alpha/beta/rc tags -release = '1.1.2' +release = "1.2" # -- General configuration --------------------------------------------------- @@ -39,15 +40,15 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.coverage', - 'sphinx.ext.imgmath', - 'sphinx.ext.viewcode', - 'sphinx.ext.githubpages', - 'sphinx.ext.napoleon', + "sphinx.ext.autodoc", + "sphinx.ext.doctest", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.coverage", + "sphinx.ext.imgmath", + "sphinx.ext.viewcode", + "sphinx.ext.githubpages", + "sphinx.ext.napoleon", ] napoleon_google_docstring = False @@ -55,29 +56,28 @@ napoleon_use_ivar = True # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = 'en' +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', - '**.ipynb_checkpoints'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = None @@ -88,8 +88,10 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' -html_theme_path = ["_themes", ] +html_theme = "sphinx_rtd_theme" +html_theme_path = [ + "_themes", +] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -103,7 +105,7 @@ # 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, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -120,7 +122,7 @@ # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'SUSIdoc' +htmlhelp_basename = "SUSIdoc" # -- Options for LaTeX output ------------------------------------------------ @@ -129,15 +131,12 @@ # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. # # 'preamble': '', - # Latex figure (float) alignment # # 'figure_align': 'htbp', @@ -147,8 +146,7 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'SuSi.tex', 'SuSi Documentation', - 'Felix M. Riese', 'manual'), + (master_doc, "SuSi.tex", "SuSi Documentation", "Felix M. Riese", "manual"), ] @@ -156,10 +154,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'susi', 'SuSi Documentation', - [author], 1) -] +man_pages = [(master_doc, "susi", "SuSi Documentation", [author], 1)] # -- Options for Texinfo output ---------------------------------------------- @@ -168,9 +163,15 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'SuSi', 'SuSi Documentation', - author, 'SuSi', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "SuSi", + "SuSi Documentation", + author, + "SuSi", + "One line description of project.", + "Miscellaneous", + ), ] @@ -189,7 +190,7 @@ # epub_uid = '' # A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] +epub_exclude_files = ["search.html"] # -- Extension configuration ------------------------------------------------- @@ -197,7 +198,7 @@ # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = {"https://docs.python.org/": None} # -- Options for todo extension ---------------------------------------------- diff --git a/meta.yaml b/meta.yaml index a0520f5..361992e 100644 --- a/meta.yaml +++ b/meta.yaml @@ -1,5 +1,5 @@ {% set name = "susi" %} -{% set version = "1.1.2" %} +{% set version = "1.2" %} package: diff --git a/setup.py b/setup.py index 6ef27f3..3684fbd 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ setuptools.setup( name="susi", - version="1.1.2", + version="1.2", author="Felix M. Riese", author_email="github@felixriese.de", description=( diff --git a/susi/__init__.py b/susi/__init__.py index 3cdb9cf..e70f44a 100644 --- a/susi/__init__.py +++ b/susi/__init__.py @@ -4,7 +4,7 @@ self-organizing maps (SOM). """ -__version__ = "1.1.2" +__version__ = "1.2" from .SOMClassifier import SOMClassifier from .SOMClustering import SOMClustering