[issue30433] Devguide lacks instructions for building docs

[Mariatta Wijaya]

Mariatta Wijaya added the comment:

Thanks Caleb.

This has been addressed in the Dev Guide PR 
https://github.com/python/devguide/pull/206 and it has been merged.

--
nosy: +Mariatta
resolution:  -> fixed
stage:  -> resolved
status: open -> closed
versions:  -Python 3.7

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue30433] Devguide lacks instructions for building docs

[Caleb Hattingh]

Caleb Hattingh added the comment:

The PR has been merged by Mariatta so I think this can be closed.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue30433] Devguide lacks instructions for building docs

[Caleb Hattingh]

Caleb Hattingh added the comment:

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

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue30433] Devguide lacks instructions for building docs

[Caleb Hattingh]

Changes by Caleb Hattingh :


--
pull_requests:  -1812

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue30433] Devguide lacks instructions for building docs

[Stéphane Wirtel]

Stéphane Wirtel added the comment:

Hello,

Are you sure about the PR ?

--
nosy: +matrixise

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue30433] Devguide lacks instructions for building docs

[Caleb Hattingh]

New submission from Caleb Hattingh:

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 ' where  is one of
  html   to make standalone HTML files
  dirhtmlto 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
  devhelpto 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
  manto make manual pages
  changesto make an overview of all changed/added/deprecated items
  linkcheck  to check all external links for integrity
  doctestto 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.

--
assignee: docs@python
components: Documentation
messages: 294170
nosy: cjrh, docs@python
priority: normal
pull_requests: 1812
severity: normal
status: open
title: Devguide lacks instructions for building docs
versions: Python 3.7

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com