Include LMS and CMS SDKs in the developer documentation

Description

The T&L team have expressed that our productivity is impacted by not having good access to technical documentation. The Open edX code base has a lot of useful documentation strings that would be incredibly valuable to have as a browsable documentation set. This would also be equally beneficial to the whole Open edX community.

Currently the bulk of the code-generated developer documentation is for lib/common which is only a small part of the code:

http://edx.readthedocs.org/projects/edx-developer-guide/en/latest/common-lib.html

My understanding is that the documentation doesn't build currently so clearly fixing that is a prerequisite. There is a sense that developers would prioritize this now if there was a belief that it would become a valuable resource for everyone.

Steps to Reproduce

None

Current Behavior

None

Expected Behavior

None

Reason for Variance

None

Release Notes

None

User Impact Summary

None

Activity

Show:
Sylvia Pearce
September 20, 2016, 8:53 PM

We are not currently staffed for dev doc work.

hoeberR
December 17, 2014, 8:36 PM

and move developer doc to documentation repo

hoeberR
December 17, 2014, 7:54 PM

to include work of separating docstrings and rest of developers guide

hoeberR
December 10, 2014, 8:44 PM

will create subtasks post grooming

Assignee

Unassigned

Reporter

Andy Armstrong

Labels

None

Reach

None

Impact

None

Platform Area

None

Customer

None

Partner Manager

None

URL

None

Contributor Name

None

Groups with Read-Only Access

None

Actual Points

None

Category of Work

None

Platform Map Area (Levels 1 & 2)

None

Platform Map Area (Levels 3 & 4)

None

Story Points

8

Epic Link

Priority

CAT-1