a19cd28f20
Change I49b659948f35381a44e2fb5f91dd6bf9e8ef619e provided a mechanism to
include the release note cache into generated sdists. Unfortunately,
attempting to build documentation with these tarballs generates the
following error:
Exception occurred:
File ".../lib/python3.7/site-packages/dulwich/repo.py", line 1004, in discover
"No git repository was found at %(path)s" % dict(path=start)
dulwich.errors.NotGitRepository: No git repository was found at PATH
This is because we're attempting to find the root of the git repo using
dulwich, which clearly isn't possible outside of a git repo.
Work around this by falling back to a search. We consider three options:
'.', '..', and '../..', which will handle calling Sphinx from the
rootdir, a 'docs' dir, and a 'docs/source' dir, which seem to be the
most common configurations.
We have no test coverage of the Sphinx integration so this is tested
manually.
Change-Id: Ic3a8ab8b127fd5bf51b91ac6e83d459ffc087fc4
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Story: #1520096
Task: #6724
10 lines
434 B
YAML
10 lines
434 B
YAML
---
|
|
fixes:
|
|
- |
|
|
Previously, it was not possible build documentation that used the
|
|
``release-notes`` Sphinx extension from tarballs. The Sphinx extension
|
|
will now search the following directories, relative to the working
|
|
directory of the ``sphinx-build`` tool, to find the release notes
|
|
directory: ``.``, ``..``, and ``../..``. This only applies when it is
|
|
not possible to discover this information using git.
|