-
-
Notifications
You must be signed in to change notification settings - Fork 850
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
Comments
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 ? |
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:
Once I manually created the venv and installed sphinx and blurb, then it works. |
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. |
|
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 haveblurb
installed.The documentation should be updated with the instruction to install
blurb
too.The text was updated successfully, but these errors were encountered: