Merge pull request #208 from jedwards4b/master_to_main

rename master to main

.github/workflows/bumpversion.yml

@@ -2,7 +2,7 @@ name: Bump version
 on:
   push:
     branches:
-      - master
+      - main
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/extbuild.yml

@@ -1,12 +1,12 @@
 # This is a workflow to compile the cdeps source without cime
 name: extbuild
 # Controls when the action will run. Triggers the workflow on push or pull request
-# events but only for the master branch
+# events but only for the main branch
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:

README.md

@@ -8,7 +8,7 @@ https://escomp.github.io/CDEPS/html/index.html
 ## A note on github tag action
 
 This repository is setup to automatically create tags on merge to
-master using .github/workflows/bumpversion.yml It uses
+main using .github/workflows/bumpversion.yml It uses
 https://github.com/mathieudutour/github-tag-action  to look for
 keywords in commit messages and determine what the new version should
 be.  The default if no keywords is found is to bump the patch version.

doc/source/conf.py

@@ -16,8 +16,10 @@
 # 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.
 #
+# pylint: disable=unused-import
 import os
 import sys
+
 # Note that we need a specific version of sphinx_rtd_theme. This can be obtained with:
 # pip install git+https://github.com/esmci/sphinx_rtd_theme.git@version-dropdown-with-fixes
 import sphinx_rtd_theme
@@ -32,57 +34,58 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.githubpages',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.todo',
-    'sphinxcontrib.programoutput'
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.todo",
+    "sphinxcontrib.programoutput",
 ]
-todo_include_todos=True
+todo_include_todos = 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'
+# The main toctree document.
+main_doc = "index"
 
 # General information about the project.
-project = u'CDEPS'
-copyright = u'2020, U.S. National Science Foundation'
-author = u'Staff of the NSF/CESM project and NOAA/EMC'
+project = "CDEPS"
+# pylint: disable=redefined-builtin
+copyright = "2020, U.S. National Science Foundation"
+author = "Staff of the NSF/CESM project and NOAA/EMC"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'master'
+version = "main"
 # The full version, including alpha/beta/rc tags.
-release = u'master'
+release = "main"
 
 # 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 patterns also effect to html_static_path and html_extra_path
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
@@ -92,32 +95,32 @@
 # 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 = "sphinx_rtd_theme"
 
 # 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
 # documentation.
 #
-#html_theme_options = {"stickysidebar": "true"}
+# html_theme_options = {"stickysidebar": "true"}
 
 # The 'versions' option needs to have at least two versions to work, but it doesn't need
 # to have all versions: others will be added dynamically. Note that this maps from version
 # names to html links. The current version can link to the current location (i.e., do
 # nothing). For the other version, we just add a place-holder; its name and value are
 # unimportant because these versions will get replaced dynamically.
 html_theme_options = {}
-html_theme_options['versions'] = {version: ''}
-html_theme_options['versions']['[placeholder]'] = ''
+html_theme_options["versions"] = {version: ""}
+html_theme_options["versions"]["[placeholder]"] = ""
 
 # 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"]
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'ondoc'
+htmlhelp_basename = "ondoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -126,15 +129,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',
@@ -144,19 +144,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'on.tex', u'on Documentation',
-     u'Staff of the NCAR and NOAA/EMC', 'manual'),
+    (
+        main_doc,
+        "on.tex",
+        "on Documentation",
+        "Staff of the NCAR and NOAA/EMC",
+        "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, 'on', u'on Documentation',
-     [author], 1)
-]
+man_pages = [(main_doc, "on", "on Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -165,15 +167,23 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'on', u'on Documentation',
-     author, 'on', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        main_doc,
+        "on",
+        "on Documentation",
+        author,
+        "on",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # -- Options for pdf output -------------------------------------------------
 
 pdf_documents = [
-    (master_doc,
-     u'CDEPS_Users_Guide',
-     u'CDEPS Users Guide (PDF)',)
+    (
+        main_doc,
+        "CDEPS_Users_Guide",
+        "CDEPS Users Guide (PDF)",
+    )
 ]