Skip to content

fix buiding documentation with sphinx 8.x#684

Merged
mmckerns merged 3 commits intouqfoundation:masterfrom
kloczek:master
Oct 2, 2024
Merged

fix buiding documentation with sphinx 8.x#684
mmckerns merged 3 commits intouqfoundation:masterfrom
kloczek:master

Conversation

@kloczek
Copy link
Contributor

@kloczek kloczek commented Oct 1, 2024

Summary

Without this fix documentation build build fails with sphinx 8.x with

+ /usr/bin/sphinx-build -n -T -b man docs/source build/sphinx/man
Running Sphinx v8.0.2
loading translations [en]... done
making output directory... done
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
ERROR: Invalid value `None` in intersphinx_mapping['https://docs.python.org/3/']. Expected a two-element tuple or list.

Traceback (most recent call last):
  File "/usr/lib/python3.10/site-packages/sphinx/cmd/build.py", line 332, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/usr/lib/python3.10/site-packages/sphinx/application.py", line 277, in __init__
    self.events.emit('config-inited', self.config)
  File "/usr/lib/python3.10/site-packages/sphinx/events.py", line 100, in emit
    results.append(listener.handler(self.app, *args))
  File "/usr/lib/python3.10/site-packages/sphinx/ext/intersphinx/_load.py", line 127, in validate_intersphinx_mapping
    raise ConfigError(msg)
sphinx.errors.ConfigError: Invalid `intersphinx_mapping` configuration (1 error).

Configuration error:
Invalid `intersphinx_mapping` configuration (1 error).

Checklist

Documentation and Tests

  • Added relevant tests that run with python tests/__main__.py, and pass.
  • Added relevant documentation that builds in sphinx without error.
  • Added new features that are documented with examples.
  • Artifacts produced with the main branch work as expected under this PR.

Release Management

  • Added "Fixes #NNN" in the PR body, referencing the issue (#NNN) it closes.
  • Added a comment to issue #NNN, linking back to this PR.
  • Added rationale for any breakage of backwards compatibility.
  • Requested a review.

Signed-off-by: Tomasz Kłoczko <kloczek@github.com>
Small fix which allows build documentation out of source tree without
have `dill` installed.
This will guarantee that documentation is always build against proper
`dill` version.

Signed-off-by: Tomasz Kłoczko <kloczek@github.com>
@mmckerns mmckerns added this to the dill-0.4.0 milestone Oct 1, 2024
@mmckerns
Copy link
Member

mmckerns commented Oct 1, 2024

I have a commented out block below the offending line using the new format (as you probably noticed). I didn't convert to the new format yet as I wanted to first determine a rationale for adding something to the intersphinx mapping... but if the new format is a requirement for 8.x, then the time for that decision is now. Probably the right approach is to fix it with the minimal set first (i.e. as you have done), and then expand later as needed.

Copy link
Member

@mmckerns mmckerns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I think we can probably pull this as is. I'm going to ponder inclusion of some of the commented out lines in the tail of the file, then will pull.

@mmckerns mmckerns self-assigned this Oct 1, 2024
@mmckerns mmckerns merged commit bc71737 into uqfoundation:master Oct 2, 2024
@kloczek
Copy link
Contributor Author

kloczek commented Oct 2, 2024

Thank you 👍

@mmckerns
Copy link
Member

mmckerns commented Oct 2, 2024

thank you :)

luketainton pushed a commit to luketainton/repos_pypilot that referenced this pull request Jan 5, 2026
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [dill](https://github.com/uqfoundation/dill) | project.dependencies | minor | `==0.3.9` -> `==0.4.0` |

---

### Release Notes

<details>
<summary>uqfoundation/dill (dill)</summary>

### [`v0.4.0`](https://github.com/uqfoundation/dill/releases/tag/0.4.0)

[Compare Source](uqfoundation/dill@0.3.9...0.4.0)

### 0.4.0 Release Notes

With `dill`, you can serialize almost anything in python, even an entire interpreter session.  If you encounter any pickling failures, `dill` also has some good tools to help you discover why your object fails to pickle.

`dill` installs with `pip`:
`$ pip install dill`

`dill` requires:
`- python or pypy, >=3.8`

Optional requirements:
`- pyreadline, >=1.7.1` (install with `$ pip install dill[readline]`)
`- objgraph, >=1.7.2` (install with `$ pip install dill[graph]`)

`dill` is licensed under 3-clause BSD:

    >>> import dill
    >>> print (dill.license())

To cite `dill`:

    >>> import dill
    >>> print (dill.citation())

#### What's Changed

-   update travis badge link by [@&#8203;mmckerns](https://github.com/mmckerns) in uqfoundation/dill#683
-   fix buiding documentation with sphinx 8.x by [@&#8203;kloczek](https://github.com/kloczek) in uqfoundation/dill#684
-   add initial support for python 3.14 by [@&#8203;mmckerns](https://github.com/mmckerns) in uqfoundation/dill#691
-   Bump starlette from 0.37.2 to 0.40.0 in /docs by [@&#8203;dependabot](https://github.com/dependabot) in uqfoundation/dill#686
-   fix typo in requirements.txt by [@&#8203;mmckerns](https://github.com/mmckerns) in uqfoundation/dill#693
-   updated copyright for 2025 by [@&#8203;mmckerns](https://github.com/mmckerns) in uqfoundation/dill#696
-   Bump jinja2 from 3.1.4 to 3.1.5 in /docs by [@&#8203;dependabot](https://github.com/dependabot) in uqfoundation/dill#695
-   support pypy-3.11 by [@&#8203;mmckerns](https://github.com/mmckerns) in uqfoundation/dill#701
-   update docs requirements; CI for pypy3.11 by [@&#8203;mmckerns](https://github.com/mmckerns) in uqfoundation/dill#702
-   fix CodeType support for PyPy3.11 7.3.19+ by [@&#8203;mgorny](https://github.com/mgorny) in uqfoundation/dill#707
-   move travis build of 3.9 to focal by [@&#8203;mmckerns](https://github.com/mmckerns) in uqfoundation/dill#708
-   Bump jinja2 from 3.1.5 to 3.1.6 in /docs by [@&#8203;dependabot](https://github.com/dependabot) in uqfoundation/dill#705

#### New Contributors

-   [@&#8203;kloczek](https://github.com/kloczek) made their first contribution in uqfoundation/dill#684

**Full Changelog**: uqfoundation/dill@0.3.9...0.4.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yNDUuMiIsInVwZGF0ZWRJblZlciI6IjM5LjI0NS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJ0eXBlL2RlcGVuZGVuY2llcyJdfQ==-->

Reviewed-on: https://git.tainton.uk/repos/pypilot/pulls/327
Reviewed-by: Luke Tainton <luke@tainton.uk>
Co-authored-by: Renovate [BOT] <renovate-bot@git.tainton.uk>
Co-committed-by: Renovate [BOT] <renovate-bot@git.tainton.uk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants