Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
# Conflicts:
#	docs/conf.py
  • Loading branch information
jaraco committed Sep 27, 2022
2 parents f21581f + b4f0ae6 commit 4f1a032
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 13 deletions.
16 changes: 11 additions & 5 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,26 @@ jobs:
strategy:
matrix:
python:
- 3.7
- '3.10'
- '3.11'
- "3.7"
- "3.10"
- "3.11"
# Workaround for actions/setup-python#508
dev:
- -dev
platform:
- ubuntu-latest
- macos-latest
- windows-latest
include:
- python: pypy3.9
platform: ubuntu-latest
runs-on: ${{ matrix.platform }}
steps:
- uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python }}-dev
python-version: ${{ matrix.python }}${{ matrix.dev }}
- name: Install tox
run: |
python -m pip install tox
Expand Down Expand Up @@ -52,7 +58,7 @@ jobs:
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: "3.11-dev"
python-version: 3.11-dev
- name: Install tox
run: |
python -m pip install tox
Expand Down
20 changes: 13 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
# -*- coding: utf-8 -*-

extensions = [
"sphinx.ext.autodoc",
"jaraco.packaging.sphinx",
"rst.linker",
"sphinx.ext.viewcode",
'sphinx.ext.autodoc',
'jaraco.packaging.sphinx',
]

master_doc = "index"

# Link dates and other references in the changelog
extensions += ['rst.linker']
link_files = {
'../CHANGES.rst': dict(
using=dict(GH='https://github.com'),
Expand All @@ -34,7 +34,7 @@
)
}

# Be strict about any broken references:
# Be strict about any broken references
nitpicky = True

nitpick_ignore = [
Expand All @@ -49,9 +49,15 @@
'python': ('https://docs.python.org/3', None),
}

# Preserve authored syntax for defaults
autodoc_preserve_defaults = True


extensions += ['jaraco.tidelift']

extensions += ['sphinx.ext.viewcode']

for dependency in 'jaraco.text tempora jaraco.collections'.split():
rtd_name = dependency.replace('.', '')
url = f'https://{rtd_name}.readthedocs.io/en/latest'
intersphinx_mapping.update({dependency: (url, None)})

extensions += ['jaraco.tidelift']
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ testing =

docs =
# upstream
sphinx
sphinx >= 3.5
jaraco.packaging >= 9
rst.linker >= 1.9
jaraco.tidelift >= 1.4
Expand Down

0 comments on commit 4f1a032

Please sign in to comment.