Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation warnings #66717

Closed
pitrou opened this issue Sep 30, 2014 · 2 comments
Closed

Documentation warnings #66717

pitrou opened this issue Sep 30, 2014 · 2 comments
Labels
docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@pitrou
Copy link
Member

pitrou commented Sep 30, 2014

BPO 22527
Nosy @birkenfeld, @pitrou

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2014-09-30.19:21:24.899>
created_at = <Date 2014-09-30.19:01:41.068>
labels = ['type-bug', 'docs']
title = 'Documentation warnings'
updated_at = <Date 2014-09-30.19:21:24.897>
user = 'https://github.com/pitrou'

bugs.python.org fields:

activity = <Date 2014-09-30.19:21:24.897>
actor = 'georg.brandl'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-09-30.19:21:24.899>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2014-09-30.19:01:41.068>
creator = 'pitrou'
dependencies = []
files = []
hgrepos = []
issue_num = 22527
keywords = []
message_count = 2.0
messages = ['227978', '227980']
nosy_count = 3.0
nosy_names = ['georg.brandl', 'pitrou', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = 'third party'
stage = None
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue22527'
versions = ['Python 3.5']
@pitrou
Copy link
Member Author

pitrou commented Sep 30, 2014

I get the following warnings when building the doc:

                                                                              
$ make html
sphinx-build -b html -d build/doctrees -D latex_paper_size=  . build/html 
Running Sphinx v1.2.1
loading pickled environment... done
building [html]: targets for 65 source files that are out of date
updating environment: 1 added, 66 changed, 0 removed
reading sources... [100%] whatsnew/changelog                                           
/home/antoine/cpython/default/Doc/library/compileall.rst:23: WARNING: Malformed option description u'directory ...', should look like "-opt args", "--opt args" or "/opt args"
/home/antoine/cpython/default/Doc/library/compileall.rst:23: WARNING: Malformed option description u'file ...', should look like "-opt args", "--opt args" or "/opt args"
/home/antoine/cpython/default/Doc/library/json.rst:593: WARNING: Malformed option description u'infile', should look like "-opt args", "--opt args" or "/opt args"
/home/antoine/cpython/default/Doc/library/json.rst:611: WARNING: Malformed option description u'outfile', should look like "-opt args", "--opt args" or "/opt args"
/home/antoine/cpython/default/Doc/tutorial/appendix.rst:69: WARNING: duplicate label tut-startup, other instance in /home/antoine/cpython/default/Doc/tutorial/interpreter.rst
/home/antoine/cpython/default/Doc/tutorial/appendix.rst:16: WARNING: duplicate label tut-error, other instance in /home/antoine/cpython/default/Doc/tutorial/interpreter.rst
/home/antoine/cpython/default/Doc/tutorial/appendix.rst:102: WARNING: duplicate label tut-customize, other instance in /home/antoine/cpython/default/Doc/tutorial/interpreter.rst
/home/antoine/cpython/default/Doc/tutorial/appendix.rst:38: WARNING: duplicate label tut-scripts, other instance in /home/antoine/cpython/default/Doc/tutorial/interpreter.rst
/home/antoine/cpython/default/Doc/using/cmdline.rst:167: WARNING: Malformed option description u'-?', should look like "-opt args", "--opt args" or "/opt args"

@pitrou pitrou added docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error labels Sep 30, 2014
@birkenfeld
Copy link
Member

These are a bug in Sphinx 1.2.1 and fixed in 1.2.2.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@birkenfeld @pitrou