[issue18707] the readme should also talk about how to build doc.
New submission from madan ram: Since most of and also I faced problem of building Doc initially then later i found out how to build Doc. So i thought to include details on how to build Doc in README. ---------- assignee: docs@python components: Build, Devguide, Documentation, Installation files: README.diff keywords: patch messages: 194866 nosy: docs@python, eric.araujo, ezio.melotti, georg.brandl, madan.ram priority: normal severity: normal status: open title: the readme should also talk about how to build doc. versions: Python 3.4 Added file: http://bugs.python.org/file31227/README.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
Éric Araujo added the comment: There is a README in the Doc directory. Wouldn’t it be enough to point to that file from the main README? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
Ezio Melotti added the comment: +1 ---------- type: -> enhancement versions: +Python 2.7, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
Madison May added the comment: Here's a patch that adds a short sentence to the README's `Documentation` section that refers readers to the Doc/README.txt file. ---------- nosy: +madison.may Added file: http://bugs.python.org/file31267/README_v2.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
Éric Araujo added the comment: Thanks for the patch! One thing: Doc/README.txt does not actually mention how to contribute to the doc, does it? Maybe the main README should link to the devguide instead of or in addition to Doc/README.txt ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
Madison May added the comment: Good point, Éric. It refers readers to the bug tracker, the Sphinx bug tracker, and docs@python.org in the `Contributing` section, but a link to the devguide would probably be more useful. I've tweaked the patch a bit to reflect this. ---------- Added file: http://bugs.python.org/file31268/README_v3.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
Madison May added the comment: Or perhaps with an alternate wording: README_v4.diff ---------- Added file: http://bugs.python.org/file31269/README_v4.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
Éric Araujo added the comment: Either one looks good to me. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
Roundup Robot added the comment: New changeset 6bc88d61f302 by Ezio Melotti in branch '2.7': #18707: point to Doc/README.txt in the README file. Patch by Madison May. http://hg.python.org/cpython/rev/6bc88d61f302 New changeset 477a143bfbfd by Ezio Melotti in branch '3.3': #18707: point to Doc/README.txt in the README file. Patch by Madison May. http://hg.python.org/cpython/rev/477a143bfbfd New changeset 96c51207e7cd by Ezio Melotti in branch 'default': #18707: merge with 3.3. http://hg.python.org/cpython/rev/96c51207e7cd ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
Ezio Melotti added the comment: Fixed, thanks for the report and the patch! ---------- assignee: docs@python -> ezio.melotti resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18707> _______________________________________
participants (5)
-
Ezio Melotti -
madan ram
-
Madison May
-
Roundup Robot
-
Éric Araujo