This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Devguide lacks instructions for building docs
Type: Stage: resolved
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Mariatta, cjrh, docs@python, matrixise
Priority: normal Keywords:

Created on 2017-05-22 18:51 by cjrh, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (5)
msg294170 - (view) Author: Caleb Hattingh (cjrh) * Date: 2017-05-22 18:51
The official devguide at https://github.com/python/devguide does not include instructions on exactly how to build the docs!  If, after cloning, you simply type `make`, you get some helpful output:

$ make
Please use `make <target>' where <target> is one of
  html       to make standalone HTML files
  dirhtml    to make HTML files named index.html in directories
  singlehtml to make a single large HTML file
  pickle     to make pickle files
  json       to make JSON files
  htmlhelp   to make HTML files and a HTML help project
  qthelp     to make HTML files and a qthelp project
  devhelp    to make HTML files and a Devhelp project
  epub       to make an epub
  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  latexpdf   to make LaTeX files and run them through pdflatex
  text       to make text files
  man        to make manual pages
  changes    to make an overview of all changed/added/deprecated items
  linkcheck  to check all external links for integrity
  doctest    to run all doctests embedded in the documentation (if enabled)
  check      to run a check for frequent markup errors

However, in order to build, say, HTML, you need to have sphinx installed in your environment.  I would like to add a `requirements.txt` file that will specify which dependencies must be installed (into a virtualenv, probably), in order to successfully build the documentation.  In the GitHub PR, I have also added a BUILDING.rst that explains how to install the dependencies for building the documentation.
msg294171 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2017-05-22 19:00
Hello,

Are you sure about the PR ?
msg294173 - (view) Author: Caleb Hattingh (cjrh) * Date: 2017-05-22 19:21
Oops, sorry!  The PR was wrong because it auto-assumes the main cpython repo, but my PR is in the devguide repo. This is the URL for the PR:

https://github.com/python/devguide/pull/206
msg294555 - (view) Author: Caleb Hattingh (cjrh) * Date: 2017-05-26 16:40
The PR has been merged by Mariatta so I think this can be closed.
msg294557 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-05-26 16:50
Thanks Caleb.

This has been addressed in the Dev Guide PR https://github.com/python/devguide/pull/206 and it has been merged.
History
Date User Action Args
2022-04-11 14:58:46adminsetgithub: 74618
2017-05-26 16:50:50Mariattasetstatus: open -> closed

versions: - Python 3.7
nosy: + Mariatta

messages: + msg294557
resolution: fixed
stage: resolved
2017-05-26 16:40:55cjrhsetmessages: + msg294555
2017-05-22 19:21:46cjrhsetmessages: + msg294173
2017-05-22 19:20:21cjrhsetpull_requests: - pull_request1812
2017-05-22 19:00:54matrixisesetnosy: + matrixise
messages: + msg294171
2017-05-22 18:51:43cjrhcreate