Bug 1974 - BitBake Contributor documentation
Summary: BitBake Contributor documentation
Status: RESOLVED WONTFIX
Alias: None
Product: BitBake
Classification: Build System, Metadata & Runtime
Component: bitbake (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Low enhancement
Target Milestone: Future
Assignee: Michael Opdenacker
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2012-02-09 14:49 UTC by Joshua Lock - Disabled
Modified: 2022-05-20 16:53 UTC (History)
5 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
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.