Skip to content

Commit

Permalink
Merge pull request #230 from dhellmann/ci-fixes-2024
Browse files Browse the repository at this point in the history
CI fixes
  • Loading branch information
dhellmann authored Dec 19, 2024
2 parents 51debaa + b86d87a commit 13ac4cc
Show file tree
Hide file tree
Showing 11 changed files with 388 additions and 279 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ jobs:

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'

- name: Install dependencies
run: python -m pip install tox
Expand Down
4 changes: 1 addition & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@ jobs:
fail-fast: false
matrix:
python-version:
- 3.7
- 3.8
- 3.9
- '3.10'
- '3.11'
- '3.12'

steps:
- uses: actions/checkout@v4
Expand Down
33 changes: 15 additions & 18 deletions .mergify.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
pull_request_rules:

- name: Add CI label
conditions:
- or:
Expand All @@ -25,23 +24,21 @@ pull_request_rules:
- name: Automatic merge on approval
conditions:
- and:
- "check-success=build (docs)"
- "check-success=build (isolated)"
- "check-success=build (linter)"
- "check-success=build (spelling)"
- "check-success=django"
- "check-success=build (3.7)"
- "check-success=build (3.8)"
- "check-success=build (3.9)"
- "check-success=build (3.10)"
- "check-success=build (3.11)"
- "-draft"
- or:
- "check-success=history-update"
- "label=ci"
- or:
- "approved-reviews-by=dhellmann"
- "author=dhellmann"
- "check-success=build (docs)"
- "check-success=build (isolated)"
- "check-success=build (linter)"
- "check-success=build (spelling)"
- "check-success=django"
- "check-success=build (3.10)"
- "check-success=build (3.11)"
- "check-success=build (3.12)"
- "-draft"
- or:
- "check-success=history-update"
- "label=ci"
- or:
- "approved-reviews-by=dhellmann"
- "author=dhellmann"
actions:
merge:
method: merge
120 changes: 65 additions & 55 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,211 +14,221 @@
# If extensions (or modules to document with autodoc) are in another directory,
# 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.
#sys.path.insert(0, os.path.abspath('.'))
# sys.path.insert(0, os.path.abspath('.'))

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinxcontrib.spelling',
"sphinxcontrib.spelling",
]

spelling_word_list_filename = [
'spelling_wordlist.txt',
"spelling_wordlist.txt",
]

spelling_show_suggestions = True
spelling_ignore_pypi_package_names = True
spelling_ignore_pypi_package_names = False
spelling_ignore_contributor_names = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"

# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# General information about the project.
project = 'sphinxcontrib.spelling'
copyright = '2011, Doug Hellmann'
project = "sphinxcontrib.spelling"
copyright = "2011, Doug Hellmann"

# 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 = '1.4'
version = "1.4"
# The full version, including alpha/beta/rc tags.
release = version

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = 'en'
language = "en"

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# modindex_common_prefix = []


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = "default"

# 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 = {}
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# html_favicon = None

# 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']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True
# html_domain_indices = True

# If false, no index is generated.
#html_use_index = True
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'sphinxcontribspellingdoc'
htmlhelp_basename = "sphinxcontribspellingdoc"


# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# latex_paper_size = 'letter'

# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# latex_font_size = '10pt'

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'sphinxcontribspelling.tex', 'sphinxcontrib.spelling Documentation',
'Doug Hellmann', 'manual'),
(
"index",
"sphinxcontribspelling.tex",
"sphinxcontrib.spelling Documentation",
"Doug Hellmann",
"manual",
),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False

# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# latex_preamble = ''

# Documents to append as an appendix to all manuals.
#latex_appendices = []
# latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True
# latex_domain_indices = True


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'sphinxcontribspelling', 'sphinxcontrib.spelling Documentation',
['Doug Hellmann'], 1)
(
"index",
"sphinxcontribspelling",
"sphinxcontrib.spelling Documentation",
["Doug Hellmann"],
1,
)
]
13 changes: 13 additions & 0 deletions docs/source/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,24 @@

.. spelling:word-list::
arg
commandline
config
docstring
emacs
env
Homebrew
libenchant
macOS
namespace
pbr
pyenchant
repo
scm
setuptools
testrepository
tox
unicode
unmaintained

Next
Expand Down
Loading

0 comments on commit 13ac4cc

Please sign in to comment.