Skip to content

Conversation

@milas
Copy link
Contributor

@milas milas commented Aug 18, 2022

The setuptools_scm docs have a recommended way to query
the version for Sphinx integration which we use:

docker-py/docs/conf.py

Lines 62 to 70 in e901eac

# 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.
#
# see https://github.com/pypa/setuptools_scm#usage-from-sphinx
from importlib.metadata import version
release = version('docker')
# for example take major/minor
version = '.'.join(release.split('.')[:2])

However, this is currently failing because it requires the docker
package (this one!) to be importable, so it really needs to have
the equivalent of pip install -e . done on it.

This updates the RTD config to actually install this package as
part of the build vs just its dependencies, so that the version
introspection (hopefully) works.

Need to install ourselves so that we can introspect on version using `setuptools_scm` in `docs/conf.py`. Signed-off-by: Milas Bowman <milas.bowman@docker.com>
@milas milas added this to the 6.0.1 milestone Aug 18, 2022
@milas milas requested a review from a team August 18, 2022 20:20
@milas milas self-assigned this Aug 18, 2022
@milas milas merged commit 2494d63 into docker:main Aug 18, 2022
@milas milas deleted the rtd-build branch August 18, 2022 21:03
@milas milas modified the milestones: 6.0.1, 6.1.0 Aug 19, 2022
coolguy1771 referenced this pull request in coolguy1771/home-ops Nov 3, 2022
This PR contains the following updates: | Package | Update | Change | |---|---|---| | [docker](https://togithub.com/docker/docker-py) ([changelog](https://docker-py.readthedocs.io/en/stable/change-log.html)) | patch | `6.0.0` -> `6.0.1` | --- ### Release Notes <details> <summary>docker/docker-py</summary> ### [`v6.0.1`](https://togithub.com/docker/docker-py/releases/tag/6.0.1) [Compare Source](https://togithub.com/docker/docker-py/compare/6.0.0...6.0.1) ##### 🐛 Bugfixes - Fix for `The pipe has been ended` errors on Windows ([#&#8203;3056](https://togithub.com/docker/docker-py/issues/3056)) - Support floats for timestamps in Docker logs (`since` / `until`) ([#&#8203;3031](https://togithub.com/docker/docker-py/issues/3031)) ##### What's Changed - docs: install package in ReadTheDocs build by [@&#8203;milas](https://togithub.com/milas) in [https://github.com/docker/docker-py/pull/3032](https://togithub.com/docker/docker-py/pull/3032) - Use latest stable syntax for Dockerfiles by [@&#8203;thaJeztah](https://togithub.com/thaJeztah) in [https://github.com/docker/docker-py/pull/3035](https://togithub.com/docker/docker-py/pull/3035) - feat: add support for floats to docker logs params since / until sinc… by [@&#8203;ArchiMoebius](https://togithub.com/ArchiMoebius) in [https://github.com/docker/docker-py/pull/3031](https://togithub.com/docker/docker-py/pull/3031) - Change prune test to use anonymous volumes by [@&#8203;cpuguy83](https://togithub.com/cpuguy83) in [https://github.com/docker/docker-py/pull/3051](https://togithub.com/docker/docker-py/pull/3051) - socket: handle npipe close by [@&#8203;nicks](https://togithub.com/nicks) in [https://github.com/docker/docker-py/pull/3056](https://togithub.com/docker/docker-py/pull/3056) ##### New Contributors - [@&#8203;ArchiMoebius](https://togithub.com/ArchiMoebius) made their first contribution in [https://github.com/docker/docker-py/pull/3031](https://togithub.com/docker/docker-py/pull/3031) - [@&#8203;nicks](https://togithub.com/nicks) made their first contribution in [https://github.com/docker/docker-py/pull/3056](https://togithub.com/docker/docker-py/pull/3056) **Full Changelog**: docker/docker-py@6.0.0...6.0.1 </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 becomes conflicted, 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://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMi4xIiwidXBkYXRlZEluVmVyIjoiMzQuMTIuMSJ9--> Co-authored-by: lumiere-bot <98047013+lumiere-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

2 participants