[docs] [issue12409] Moving "Documenting Python" to Devguide

Éric Araujo report at bugs.python.org
Sat Jul 2 14:49:01 CEST 2011

Éric Araujo <merwok at netwok.org> added the comment:

I don’t understand Fred’s replies.

> The scope of this document is much larger than Python's documentation,
> but extends to all projects written in Python that use Sphinx as their
> documentation tool.
Really?  docs.python.org/documenting is much smaller that sphinx.pocoo.org, and only seems to cover documenting Python, not any Python project.

> With that, it makes sense to keep it as part of the documentation for
> users of Python.
I don’t follow.  You’re saying that since the document also covers other projects than Python, it makes sense to include it in the Python docs?

IMO, the criterion for the devguide is to have version-independent documents in one place instead of needlessly including them with CPython and having to sync across versions.  For the Documenting Python docs, if they contain version-specific instructions, or if they contain instructions needed in a CPython tarball, then they’re in the right place, otherwise they could move to the devguide.

nosy: +eric.araujo

Python tracker <report at bugs.python.org>

More information about the docs mailing list