make html broken

[warsaw]

BPO	33543
Nosy	@warsaw, @ned-deily, @zware

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2018-05-16.17:34:05.086>
created_at = <Date 2018-05-16.16:42:41.630>
labels = ['3.8', 'docs']
title = '`make html` broken'
updated_at = <Date 2018-05-16.20:46:34.509>
user = 'https://github.com/warsaw'

bugs.python.org fields:

activity = <Date 2018-05-16.20:46:34.509>
actor = 'ned.deily'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-05-16.17:34:05.086>
closer = 'ned.deily'
components = ['Documentation']
creation = <Date 2018-05-16.16:42:41.630>
creator = 'barry'
dependencies = []
files = []
hgrepos = []
issue_num = 33543
keywords = []
message_count = 5.0
messages = ['316838', '316841', '316845', '316849', '316863']
nosy_count = 4.0
nosy_names = ['barry', 'ned.deily', 'docs@python', 'zach.ware']
pr_nums = []
priority = 'normal'
resolution = 'works for me'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue33543'
versions = ['Python 3.8']

[warsaw]

Building the documentation in the master (3.8) branch is currently broken:

% make html
make html
mkdir -p build
Building NEWS from Misc/NEWS.d with blurb
PATH=./venv/bin:$PATH sphinx-build -b html -d build/doctrees -D latex_elements.papersize= . build/html
Running Sphinx v1.7.4
loading pickled environment... not yet created

Theme error:
no theme named 'python_docs_theme' found (missing theme.conf?)
make: *** [build] Error 2

[zware]

Try make venv && make html.

[ned-deily]

Or just "make venv html".

If you already have sphinx installed somewhere, you can just:

pip install python-docs-theme

[warsaw]

On May 16, 2018, at 13:34, Ned Deily <report@bugs.python.org> wrote:

Or just "make venv html".

Shouldn’t the html target depend on venv then?

[ned-deily]

Shouldn’t the html target depend on venv then?

Back when we added support for blurb, I tried to make it such that "make html" could easily use already installed versions of sphinx-build and blurb and not require a venv. I had a particular use case for that. But if someone wants to modify the Docs Makefile to require using the venv recipe, I wouldn't object too strongly. Another approach, I guess, would be to check that the python-docs-theme is available to sphinx-build and give a better message: not sure how best to do that in the current Makefile.