[Python-Dev] Sphinx version for Python 2.x docs (original) (raw)
Éric Araujo merwok at netwok.org
Sat Jan 14 04:24:52 CET 2012
- Previous message: [Python-Dev] Sphinx version for Python 2.x docs
- Next message: [Python-Dev] Sphinx version for Python 2.x docs
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
Hi Sandro,
Thanks for getting the ball rolling on this. One style for markup, one Sphinx version to code our extensions against and one location for the documenting guidelines will make our work a bit easier.
During the build process, there are some warnings that I can understand: I assume you mean “can’t”, as you later ask how to fix them. As a general rule, they’re only warnings, so they don’t break the build, only some links or stylings, so I think it’s okay to ignore them right now.
Doc/glossary.rst:520: WARNING: unknown keyword: nonlocal That’s a mistake I did in cefe4f38fa0e. This sentence should be removed.
Doc/library/stdtypes.rst:2372: WARNING: more than one target found for cross-reference u'next': Need to use :meth:
.next
to let Sphinx find the right target (more info on request :)
Doc/library/sys.rst:651: WARNING: unknown keyword: None Should use
None
.
Doc/reference/datamodel.rst:1942: WARNING: unknown keyword: not in Doc/reference/expressions.rst:1184: WARNING: unknown keyword: is not I don’t know if these should work (i.e. create a link to the appropriate language reference section) or abuse the markup (there are “not” and “in” keywords, but no “not in” keyword → use
not in
). I’d say ignore them.
Cheers
- Previous message: [Python-Dev] Sphinx version for Python 2.x docs
- Next message: [Python-Dev] Sphinx version for Python 2.x docs
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]