classification
Title: `make html` broken
Type: Stage: resolved
Components: Documentation Versions: Python 3.8
process
Status: closed Resolution: works for me
Dependencies: Superseder:
Assigned To: docs@python Nosy List: barry, docs@python, ned.deily, zach.ware
Priority: normal Keywords:

Created on 2018-05-16 16:42 by barry, last changed 2018-05-16 20:46 by ned.deily. This issue is now closed.

Messages (5)
msg316838 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2018-05-16 16:42
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
msg316841 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2018-05-16 16:56
Try `make venv && make html`.
msg316845 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2018-05-16 17:34
Or just "make venv html".

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

pip install python-docs-theme
msg316849 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2018-05-16 18:36
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?
msg316863 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2018-05-16 20:46
> 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.
History
Date User Action Args
2018-05-16 20:46:34ned.deilysetmessages: + msg316863
2018-05-16 18:36:58barrysetmessages: + msg316849
2018-05-16 17:34:05ned.deilysetstatus: open -> closed

nosy: + ned.deily
messages: + msg316845

resolution: works for me
stage: resolved
2018-05-16 16:56:16zach.waresetnosy: + zach.ware
messages: + msg316841
2018-05-16 16:42:41barrycreate