Skip to content

Mention that building Python docs now requires blurb #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Mariatta opened this issue Feb 4, 2018 · 4 comments
Closed

Mention that building Python docs now requires blurb #323

Mariatta opened this issue Feb 4, 2018 · 4 comments

Comments

@Mariatta
Copy link
Member

Mariatta commented Feb 4, 2018

This section describes how to build the docs: https://devguide.python.org/documenting/#building-the-documentation

It currently mentions that we need to have sphinx installed. However, I noticed that blurb is now needed for building the docs.

make html will fail if we don't have blurb installed.

The documentation should be updated with the instruction to install blurb too.

@Mariatta Mariatta changed the title Mention that building Python docs now require blurb Mention that building Python docs now requires blurb Feb 4, 2018
@matrixise
Copy link
Member

matrixise commented Feb 6, 2018

I have read the code of Doc/Makefile, and we install blurb when we create the venv, https://github.com/python/cpython/blob/master/Doc/Makefile#L126

Do we need to update the documentation ?

@Mariatta
Copy link
Member Author

Mariatta commented Feb 8, 2018

Hmm maybe something wrong with my computer setup?

I did make html from the Doc directory and it does not work. Here's the output from my terminal:

$ make -C Doc html
mkdir -p build
Building NEWS from Misc/NEWS.d with blurb
/bin/sh: blurb: command not found
make: *** [build] Error 127
$ cd Doc
$ make html
mkdir -p build
Building NEWS from Misc/NEWS.d with blurb
/bin/sh: blurb: command not found
make: *** [build] Error 127
$

Once I manually created the venv and installed sphinx and blurb, then it works.

@Mariatta
Copy link
Member Author

Mariatta commented Feb 8, 2018

The paragraph says: "You are expected to have installed the latest stable version of Sphinx on your system or in a virtualenv, so that the Makefile can find the sphinx-build command. You can also specify the location of sphinx-build with the SPHINXBUILD make variable."

So it should mention about adding blurb in addition to sphinx, I think.

@bukun
Copy link

bukun commented Mar 13, 2019

blurb could be installed via pip.

pip3 install blurb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants