Bug 1974

Summary:	BitBake Contributor documentation
Product:	[Build System, Metadata & Runtime] BitBake	Reporter:	Joshua Lock - Disabled <josh>
Component:	bitbake	Assignee:	Michael Opdenacker <michael.opdenacker>
Status:	RESOLVED WONTFIX	QA Contact:
Severity:	enhancement
Priority:	Low	CC:	garbados, jessica.zhang, poky.bs.watcher, poky.watcher, randy.macleod
Version:	unspecified
Target Milestone:	Future
Hardware:	x86
OS:	Multiple
Whiteboard:
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	Yes (doc changes required)

Description Joshua Lock - Disabled 2012-02-09 14:49:32 UTC

BitBake is a large and complex project. It would be nice to generate more documentation to help people work on and with the code base.

This may take the form of enhancing the code comments and automatically generating documentation from the code, there are several tools for doing this with Python i.e. Sphinx.

Alternatively, or additionally, this may best be achieved by beefing up the BitBake manual.

Although this bug is different in intent to bug 1971 this documentation would likely help BitBake users too.

Comment 1 Diana Thayer 2017-07-07 22:27:14 UTC

Hello! Is a fix to this still desired? Adding Sphinx docs sounds great to me. I've worked with Sphinx in the past, so I'd be happy to tackle that.

Comment 2 Michael Opdenacker 2022-05-20 16:53:37 UTC

This bug is too wide, and we will never get to the end of such a suggestion.
We already moved the docs to Sphinx, so it's easier to contribute to the BitBake manual.
Closing it.