Skip to content

Commit

Permalink
Updated files with 'repo_helper'.
Browse files Browse the repository at this point in the history
  • Loading branch information
repo-helper[bot] committed Apr 29, 2021
1 parent 3fa7207 commit 344372a
Show file tree
Hide file tree
Showing 8 changed files with 122 additions and 109 deletions.
12 changes: 11 additions & 1 deletion .github/workflows/flake8.yml
Expand Up @@ -4,6 +4,16 @@ name: Flake8

on:
push:
paths-ignore:
- 'doc-source/**'
- 'CONTRIBUTING.rst'
- '.bumpversion.cfg'
- '.imgbotconfig'
- '.pre-commit-config.yaml'
- '.pylintrc'
- '.readthedocs.yml'
- '.style.yapf'
- 'stubs.txt'

jobs:
Run:
Expand All @@ -17,7 +27,7 @@ jobs:
- name: Setup Python 🐍
uses: "actions/setup-python@v2"
with:
python-version: "3.8"
python-version: "3.6"

- name: Install dependencies 🔧
run: |
Expand Down
10 changes: 10 additions & 0 deletions .github/workflows/mypy.yml
Expand Up @@ -4,6 +4,16 @@ name: mypy

on:
push:
paths-ignore:
- 'doc-source/**'
- 'CONTRIBUTING.rst'
- '.bumpversion.cfg'
- '.imgbotconfig'
- '.pre-commit-config.yaml'
- '.pylintrc'
- '.readthedocs.yml'
- '.style.yapf'
- 'stubs.txt'

jobs:
Run:
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/python_ci.yml
Expand Up @@ -4,6 +4,10 @@ name: Windows

on:
push:
paths-ignore:
- 'doc-source/**'
- 'CONTRIBUTING.rst'


jobs:
tests:
Expand Down
29 changes: 4 additions & 25 deletions .github/workflows/python_ci_linux.yml
Expand Up @@ -4,36 +4,15 @@ name: Linux

on:
push:
paths-ignore:
- 'doc-source/**'
- 'CONTRIBUTING.rst'

jobs:
changes:
name: "Check for changed files"
runs-on: "ubuntu-latest"

steps:
- name: Checkout 🛎️
uses: "actions/checkout@v2"

- name: Check for changed files
uses: dorny/paths-filter@v2
id: changes
with:
filters: |
not-code:
- 'doc-source/**'
- 'CONTRIBUTING.rst'
- '.bumpversion.cfg'
- '.imgbotconfig'
- '.pre-commit-config.yaml'
- '.pylintrc'
- '.readthedocs.yml'
- '.style.yapf'
- 'stubs.txt'

jobs:
tests:
name: "ubuntu-20.04 / Python ${{ matrix.config.python-version }}"
runs-on: "ubuntu-20.04"
if: jobs.changes.steps.changes.outputs.not-code == 'false'
continue-on-error: ${{ matrix.config.experimental }}
env:
USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.7,pypy-3.6,pypy-3.7'
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/python_ci_macos.yml
Expand Up @@ -4,6 +4,10 @@ name: macOS

on:
push:
paths-ignore:
- 'doc-source/**'
- 'CONTRIBUTING.rst'


jobs:
tests:
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Expand Up @@ -62,7 +62,7 @@ repos:
- --keep-runtime-typing

- repo: https://github.com/Lucas-C/pre-commit-hooks
rev: v1.1.9
rev: v1.1.10
hooks:
- id: remove-crlf
- id: forbid-crlf
Expand Down
89 changes: 9 additions & 80 deletions doc-source/conf.py
Expand Up @@ -5,90 +5,19 @@
# stdlib
import os
import re
import sys

# 3rd party
from sphinx_pyproject import SphinxConfig

config = SphinxConfig()
sys.path.append('.')

github_username = "domdfcoding"
github_repository = "dom_toml"
author = "Dominic Davis-Foster"
project = "dom-toml"
copyright = "2021 Dominic Davis-Foster"
language = "en"
package_root = "dom_toml"
extensions = [
"sphinx_toolbox",
"sphinx_toolbox.more_autodoc",
"sphinx_toolbox.more_autosummary",
"sphinx_toolbox.documentation_summary",
"sphinx_toolbox.tweaks.param_dash",
"sphinx_toolbox.tweaks.latex_toc",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinxcontrib.httpdomain",
"sphinxcontrib.extras_require",
"sphinx.ext.todo",
"sphinxemoji.sphinxemoji",
"notfound.extension",
"sphinx_copybutton",
"sphinxcontrib.default_values",
"sphinxcontrib.toctree_plus",
"sphinx_debuginfo",
"seed_intersphinx_mapping",
]
sphinxemoji_style = "twemoji"
gitstamp_fmt = "%d %b %Y"
templates_path = ["_templates"]
html_static_path = ["_static"]
source_suffix = ".rst"
master_doc = "index"
suppress_warnings = ["image.nonlocal_uri"]
pygments_style = "default"
html_theme = "furo"
html_theme_path = ["../.."]
html_show_sourcelink = True
toctree_plus_types = [
"class",
"confval",
"data",
"directive",
"enum",
"exception",
"flag",
"function",
"method",
"namedtuple",
"protocol",
"role",
"typeddict",
]
add_module_names = False
hide_none_rtype = True
all_typevars = True
overloads_location = "bottom"
documentation_summary = "Dom's tools for Tom's Obvious, Minimal Language."
autodoc_exclude_members = [
"__dict__",
"__class__",
"__dir__",
"__weakref__",
"__module__",
"__annotations__",
"__orig_bases__",
"__parameters__",
"__subclasshook__",
"__init_subclass__",
"__attrs_attrs__",
"__init__",
"__new__",
"__getnewargs__",
"__abstractmethods__",
"__hash__",
]
config = SphinxConfig(globalns=globals())
project = config["project"]
author = config["author"]
documentation_summary = config.description

github_url = f"https://github.com/{github_username}/{github_repository}"
github_url = "https://github.com/{github_username}/{github_repository}".format_map(config)

rst_prolog = f""".. |pkgname| replace:: dom_toml
.. |pkgname2| replace:: ``dom_toml``
Expand Down Expand Up @@ -125,12 +54,12 @@
man_pages = [("index", slug, project, [author], 1)]
texinfo_documents = [("index", slug, project, author, slug, project, "Miscellaneous")]

toctree_plus_types = set(toctree_plus_types)
toctree_plus_types = set(config["toctree_plus_types"])

autodoc_default_options = {
"members": None, # Include all members (methods).
"special-members": None,
"autosummary": None,
"show-inheritance": None,
"exclude-members": ','.join(autodoc_exclude_members),
"exclude-members": ','.join(config["autodoc_exclude_members"]),
}
81 changes: 79 additions & 2 deletions pyproject.toml
Expand Up @@ -7,12 +7,12 @@ name = "dom_toml"
version = "0.4.0"
description = "Dom's tools for Tom's Obvious, Minimal Language."
readme = "README.rst"
keywords = [ "toml", "serialize", "configuration",]
keywords = [ "configuration", "serialize", "toml",]
dynamic = [ "requires-python", "classifiers", "dependencies",]

[[project.authors]]
email = "dominic@davis-foster.co.uk"
name = "Dominic Davis-Foster"
email = "dominic@davis-foster.co.uk"


[project.license]
Expand All @@ -28,3 +28,80 @@ Documentation = "https://dom_toml.readthedocs.io/en/latest"
conda-channels = [ "conda-forge", "domdfcoding",]
extras = "all"
license-key = "MIT"

[tool.sphinx-pyproject]
github_username = "domdfcoding"
github_repository = "dom_toml"
author = "Dominic Davis-Foster"
project = "dom-toml"
copyright = "2021 Dominic Davis-Foster"
language = "en"
package_root = "dom_toml"
extensions = [
"sphinx_toolbox",
"sphinx_toolbox.more_autodoc",
"sphinx_toolbox.more_autosummary",
"sphinx_toolbox.documentation_summary",
"sphinx_toolbox.tweaks.param_dash",
"sphinx_toolbox.tweaks.latex_toc",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinxcontrib.httpdomain",
"sphinxcontrib.extras_require",
"sphinx.ext.todo",
"sphinxemoji.sphinxemoji",
"notfound.extension",
"sphinx_copybutton",
"sphinxcontrib.default_values",
"sphinxcontrib.toctree_plus",
"sphinx_debuginfo",
"seed_intersphinx_mapping",
]
sphinxemoji_style = "twemoji"
gitstamp_fmt = "%d %b %Y"
templates_path = [ "_templates",]
html_static_path = [ "_static",]
source_suffix = ".rst"
master_doc = "index"
suppress_warnings = [ "image.nonlocal_uri",]
pygments_style = "default"
html_theme = "furo"
html_theme_path = [ "../..",]
html_show_sourcelink = true
toctree_plus_types = [
"class",
"confval",
"data",
"directive",
"enum",
"exception",
"flag",
"function",
"method",
"namedtuple",
"protocol",
"role",
"typeddict",
]
add_module_names = false
hide_none_rtype = true
all_typevars = true
overloads_location = "bottom"
autodoc_exclude_members = [
"__dict__",
"__class__",
"__dir__",
"__weakref__",
"__module__",
"__annotations__",
"__orig_bases__",
"__parameters__",
"__subclasshook__",
"__init_subclass__",
"__attrs_attrs__",
"__init__",
"__new__",
"__getnewargs__",
"__abstractmethods__",
"__hash__",
]

0 comments on commit 344372a

Please sign in to comment.