Skip to content

v3.0.2 local html docs "git describe" error #13013

Closed
@i-cherkasov

Description

@i-cherkasov

Bug report

Bug summary

make html fails when building html docs from downloaded source (https://github.com/matplotlib/matplotlib/archive/v3.0.2.zip), probably, because .git directory is not included there. The intention is to build docs for offline use.

Code for reproduction

make html

Actual outcome

Running Sphinx v1.7.6
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).

Configuration error:
There is a programable error in your configuration file:

Traceback (most recent call last):
  File "/home/<username>/.local/lib/python3.6/site-packages/sphinx/config.py", line 161, in __init__
    execfile_(filename, config)
  File "/home/<username>/.local/lib/python3.6/site-packages/sphinx/util/pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "conf.py", line 145, in <module>
    SHA = check_output(['git', 'describe', '--dirty']).decode('utf-8').strip()
  File "/usr/lib/python3.6/subprocess.py", line 336, in check_output
    **kwargs).stdout
  File "/usr/lib/python3.6/subprocess.py", line 418, in run
    output=stdout, stderr=stderr)
subprocess.CalledProcessError: Command '['git', 'describe', '--dirty']' returned non-zero exit status 128.

Makefile:20: recipe for target 'html' failed
make: *** [html] Error 2

Expected outcome

A set of html docs.

Matplotlib version

  • Operating system: Ubuntu 18.04.1 LTS
  • Matplotlib version: 3.0.2
  • Matplotlib backend (print(matplotlib.get_backend())): agg
  • Python version: Python 3.6.6
  • Jupyter version (if applicable):
  • Other libraries:

Workaround

Modify conf.py:

#SHA = check_output(['git', 'describe', '--dirty']).decode('utf-8').strip()
SHA = "8858a0d1bdd149a0897789e8503ac586be14676d"

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions