[SUGGESTION] Create Full API Listing in Documentation

Open
#1,329 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the PiCamera2 Manual PDF and the picamera2 source, comparing the documented examples and public functions, classes, and data types. Review the original PiCamera ReadTheDocs site as a reference; done means a complete API listing is available in the manual or a published documentation site.

Written by the indexing model from the issue text.

Description

Please only include one suggestion or features request per issue!

Is your feature request related to a problem? Please describe.
While the PiCamera2 Manual is very useful for learning how to use the library, it is lacking a full listing of all functions/classes/data types available in the library.

For example, in section 6.5 there is the sentence

All the capture and switch_mode_and_capture methods take two additional arguments

but no-where in the document do we have a listing of all of these methods, I have to search through the PDF for switch_mode, but even then, it does not mention all of the functions used in the examples.

Describe the solution you'd like
A full listing of all of the public functions/classes/data types in the picamera2 library. Either listed in the PDF manual, or available elsewhere (such as using ReadTheDocs, GitHub Pages, etc)

Describe alternatives you've considered
Just digging through the PiCamera2 source: Reading the source might not be as easy for everyone, and as picamera2 can't be easily installed on non-RPi devices, makes offline development harder.

Additional context
This might be as simple as just setting up Sphinx to automatically parse the source on each release, and pushing it to a website, which can be done in a day in my experience.

For an example, here's the documentation for the original PiCamera. See sections 9 through 16 in the sidebar.
picamera.readthedocs.io

Dominant language
Python
Stars
1.2k
Forks
258
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from raspberrypi/picamera2

All issues in raspberrypi/picamera2

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.