➜
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.
Created on 2011-06-03 00:08 by tshepang, last changed 2022-04-11 14:57 by admin. This issue is now closed.
| Files | ||||
|---|---|---|---|---|
| File name | Uploaded | Description | Edit | |
| add-missing-command.diff | tshepang, 2011-06-03 00:08 | review | ||
| Messages (9) | |||
|---|---|---|---|
| msg137502 - (view) | Author: Tshepang Lekhonkhobe (tshepang) * | Date: 2011-06-03 00:08 | |
It's not indicated where one should run the command 'make html' in the "Building the documentation" page, so when it failed for me when running it from the cpython distribution root, I was left a little puzzled, searching where the problem might lie (wasting time). |
|||
| msg137533 - (view) | Author: Éric Araujo (eric.araujo) *  |
Date: 2011-06-03 15:47 | |
Your patch adds the cd before running make, but other examples and filenames (for example :file:`tools/sphinx`) are also relative to Doc. How about adding something like this after the very first paragraph: All commands in this document should be run from the :file:`Doc` directory of a Python checkout; all file and directory names are also relative to :file:`Doc`. |
|||
| msg137541 - (view) | Author: Georg Brandl (georg.brandl) * |
Date: 2011-06-03 16:02 | |
I actually like the "cd Doc" inclusion; it makes it very clear what is going on. |
|||
| msg137546 - (view) | Author: Éric Araujo (eric.araujo) * |
Date: 2011-06-03 16:17 | |
Fair enough. If you think it’s enough to let people know that all paths in :file: roles are relative to Doc, then I can commit it. |
|||
| msg137549 - (view) | Author: Georg Brandl (georg.brandl) * |
Date: 2011-06-03 16:22 | |
It's fine, yes. |
|||
| msg137564 - (view) | Author: Roundup Robot (python-dev)  |
Date: 2011-06-03 17:27 | |
New changeset 4efc9ded0a03 by Éric Araujo in branch '3.2': Document working dir for “make html” (#12249). Patch by Tshepang Lekhonkhobe. http://hg.python.org/cpython/rev/4efc9ded0a03 New changeset 41c918897286 by Éric Araujo in branch 'default': Merge #12249 fix from 3.2 http://hg.python.org/cpython/rev/41c918897286 |
|||
| msg137565 - (view) | Author: Roundup Robot (python-dev) |
Date: 2011-06-03 17:30 | |
New changeset 39c29bc8bc35 by Éric Araujo in branch '2.7': Document working dir for “make html” (#12249). Patch by Tshepang Lekhonkhobe. http://hg.python.org/cpython/rev/39c29bc8bc35 |
|||
| msg137566 - (view) | Author: Éric Araujo (eric.araujo) * |
Date: 2011-06-03 17:32 | |
Thank you for the report and patch! |
|||
| msg137572 - (view) | Author: Tshepang Lekhonkhobe (tshepang) * | Date: 2011-06-03 19:08 | |
On Fri, 2011-06-03 at 15:47 +0000, Éric Araujo wrote: > Éric Araujo <merwok@netwok.org> added the comment: > > Your patch adds the cd before running make, but other examples and filenames (for example :file:`tools/sphinx`) are also relative to Doc. How about adding something like this after the very first paragraph: > > All commands in this document should be run from the :file:`Doc` directory of a Python checkout; all file and directory names are also relative to :file:`Doc`. I actually much prefer your alternative. When I prepared the patch, I didn't take note that the rest of the page's content assumed that one should be in that directory. |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:57:18 | admin | set | github: 56458 |
| 2011-06-03 19:08:34 | tshepang | set | messages:
+ msg137572 title: Document working dir for “make html” -> add missing command |
| 2011-06-03 17:32:09 | eric.araujo | set | status: open -> closed resolution: fixed messages: + msg137566 stage: resolved |
| 2011-06-03 17:30:59 | python-dev | set | messages: + msg137565 |
| 2011-06-03 17:27:36 | python-dev | set | nosy:
+ python-dev messages: + msg137564 |
| 2011-06-03 16:22:55 | georg.brandl | set | messages: + msg137549 |
| 2011-06-03 16:17:06 | eric.araujo | set | title: add missing command -> Document working dir for “make html” messages: + msg137546 versions: + Python 2.7, Python 3.2 |
| 2011-06-03 16:02:04 | georg.brandl | set | messages: + msg137541 |
| 2011-06-03 15:47:51 | eric.araujo | set | nosy:
+ georg.brandl, eric.araujo messages: + msg137533 |
| 2011-06-03 00:08:04 | tshepang | create | |