Add a no-python option to `./mach doc`
Categories
(Developer Infrastructure :: Source Documentation, enhancement)
Tracking
(firefox112 fixed)
Tracking | Status | |
---|---|---|
firefox112 | --- | fixed |
People
(Reporter: mgaudet, Assigned: cdengler)
References
(Blocks 1 open bug)
Details
(Keywords: good-first-bug, Whiteboard: [lang=python])
Attachments
(2 files, 1 obsolete file)
Trying to check the rendering of a small .rst change, and mach doc is now about five minutes into doing python auto-doc stuff (I think?), absolutely riddled with exceptions.
It would be nice if I could run ./mach doc --no-autodoc
or something, so that I could see a rendered .rst
much faster.
Comment 1•4 years ago
|
||
Great idea! And also a great candidate for the outreachy project currently underway.
Comment 2•4 years ago
|
||
We might even want to consider making this behaviour the default, though I guess sometimes folks do want to test out references to the API docs..
Can I work on this bug? I'm an outreachy applicant.
Comment 4•4 years ago
•
|
||
Amine, feel free to attach the patch by following https://firefox-source-docs.mozilla.org/contributing/contribution_quickref.html
Comment 5•4 years ago
|
||
Hi Amine,
Are you still working on this bug?
Comment 6•4 years ago
|
||
This should never occur and is likely a bug in the implementation of that
command.
You can invoke |./mach busted| to check if this issue is already on file. If it
isn't, please use |./mach busted file doc| to report it. If |./mach busted| is
misbehaving, you can also inspect the dependencies of bug 1543241.
If filing a bug, please include the full output of mach, including this error
message.
The details of the failure are as follows:
TypeError: build_docs() got an unexpected keyword argument 'autodocs'
File "c:\firefox-source\python/mach\mach\main.py", line 490, in _run
**vars(args.command_args)
File "c:\firefox-source\python/mach\mach\registrar.py", line 107, in _run_command_handler
result = fn(**kwargs). r=ahal
Updated•4 years ago
|
Updated•4 years ago
|
Comment 7•3 years ago
|
||
Updated•3 years ago
|
Comment 8•3 years ago
|
||
The bug assignee didn't login in Bugzilla in the last 7 months.
:Sylvestre, could you have a look please?
For more information, please visit auto_nag documentation.
Updated•3 years ago
|
Updated•2 years ago
|
Updated•2 years ago
|
Updated•2 years ago
|
Updated•2 years ago
|
Updated•2 years ago
|
Comment 10•2 years ago
|
||
Comment 11•2 years ago
|
||
bugherder |
Description
•