We currently do not generate Javascript API docs

Bug #1547290 reported by Richard Jones
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Dashboard (Horizon)
In Progress
Medium
Unassigned

Bug Description

We should!

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to horizon (master)

Fix proposed to branch: master
Review: https://review.openstack.org/282134

Changed in horizon:
assignee: nobody → Richard Jones (r1chardj0n3s)
status: New → In Progress
Revision history for this message
Richard Jones (r1chardj0n3s) wrote :

I have investigated many tools to attempt to generate useful documentation. jsdoc works, but generating ngdoc using dgeni does not work. We can generate something using grunt-ngdocs but it doesn't integrate with our existing Sphinx documentation, nor is it currently possible to publish that documentation to docs.openstack.org due to the build process used during publication (i.e. "python setup.py build_sphinx").

Also, the governance docs specify that Javascript be documented using Sphinx (http://governance.openstack.org/reference/cti/javascript-cti.html).

We will investigate generating docs using Sphinx.

Changed in horizon:
importance: Undecided → High
milestone: none → newton-1
Changed in horizon:
milestone: newton-1 → newton-2
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on horizon (master)

Change abandoned by David Lyle (<email address hidden>) on branch: master
Review: https://review.openstack.org/282134
Reason: This review is > 4 weeks without comment, and failed Jenkins the last time it was checked. We are abandoning this for now. Feel free to reactivate the review by pressing the restore button and leaving a 'recheck' comment to get fresh test results.

Changed in horizon:
milestone: newton-2 → newton-3
Changed in horizon:
milestone: newton-3 → next
Ying Zuo (yingzuo)
Changed in horizon:
assignee: Richard Jones (r1chardj0n3s) → nobody
importance: High → Medium
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.