I just tried to do this in my history.rst file:
v0.1.6
~~~~~~
.. git_changelog::
:rev-list: v0.1.5..v0.1.6
:filename_filter: python/heat1d/.*\.py
v0.1.5
~~~~~~
.. git_changelog::
:rev-list: v0.1.4..v0.1.5
:filename_filter: python/heat1d/.*\.py
v0.1.4
~~~~~~
.. git_changelog::
:rev-list: v0.1.3..v0.1.4
:filename_filter: python/heat1d/.*\.py
One section with one use of git_changelog only works fine.
Here's the console output:
$ make html
sphinx-build -b html -d _build/doctrees . _build/html
Running Sphinx v2.2.0
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 8 source files that are out of date
updating environment: [new config] 8 added, 0 changed, 0 removed
/usr/local/miniconda/envs/py37/lib/python3.7/site-packages/sphinx/events.py:91: MatplotlibDeprecationWarning:
The examples.directory rcparam was deprecated in Matplotlib 3.0 and will be removed in 3.2. In the future, examples will be found relative to the 'datapath' directory.
logger.debug('[app] emitting event: %r%s', name, repr(args)[:100])
/Users/maye/Dropbox/src/heat1d/python/heat1d/main.py:docstring of heat1d.main.thermCond:14: WARNING: Footnote [1] is not referenced.
Exception occurred:
File "/usr/local/miniconda/envs/py37/lib/python3.7/site-packages/git/cmd.py", line 412, in wait
raise GitCommandError(self.args, status, errstr)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
cmdline: git diff-tree d8348fda12161dffa988985cf8c99e8561085bbf 61b7eb6c23be8be7d551c6abc32479f2261a03f7 -r --abbrev=40 --full-index -M --raw --no-color
The full traceback has been saved in /var/folders/2v/8t1spnb14bvf8xftt5bq_t0h0000gp/T/sphinx-err-x488ne9k.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
I just tried to do this in my
history.rstfile:One section with one use of
git_changelogonly works fine.Here's the console output: