Open Bug 1703037 Opened 4 months ago Updated 1 month ago

Add a no-python option to `./mach doc`

Categories

(Firefox Build System :: Documentation Infrastructure, enhancement)

enhancement

Tracking

(Not tracked)

ASSIGNED

People

(Reporter: mgaudet, Assigned: bukky.akinnadeju17)

References

(Blocks 1 open bug)

Details

Attachments

(1 file, 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.

Great idea! And also a great candidate for the outreachy project currently underway.

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.

Flags: needinfo?(mgaudet)
Flags: needinfo?(ahal)
Flags: needinfo?(mgaudet)
Flags: needinfo?(ahal)

Hi Amine,

Are you still working on this bug?

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

Assignee: nobody → bukky.akinnadeju17
Status: NEW → ASSIGNED
Attachment #9218179 - Attachment description: Bug 1703037 - Add a no-python option to ./mach doc. r=ahal → degtz Bug 1703037 - Add a no-python option to ./mach doc. r=ahal
Attachment #9223113 - Attachment is obsolete: true
You need to log in before you can comment on or make changes to this bug.