4c80eab9e7
All of openstack's documentation infrastructure is run via sphinx, including templates, html parsing, uploading, and more. Thus it behooves us to keep our javascript documentation build as similar as possible. Since we want to avoid using tox, and littering the project with pythonic artifacts, we're instead using Sphinx' own recommended build method: A Makefile. This patch adds a small but complete documentation tree for this project, including the build tools needed to create it. It satisfies the need for narrative documentation, but does not (yet) satisfy the need for code doc generation. It also includes a section for specifications, as this effort is not yet large enough to warrant its own specification repo. Code documentation will need to be added in a subsequent patch, using Sphinx' jsdoc plugins. Change-Id: I40eab962d4e4c6eafd1b1499bb00e6af5d72ede0
24 lines
670 B
ReStructuredText
24 lines
670 B
ReStructuredText
========================
|
|
OpenStack JavaScript SDK
|
|
========================
|
|
|
|
Welcome to the OpenStack JavaScript SDK. This SDK is still under
|
|
construction, and many design decisions are being made. If you'd like to be
|
|
involved in this process, please take a look at the specifications and
|
|
patches under discussion in gerrit_, or come visit us in
|
|
`#openstack-javascript`_ on FreeNode (IRC).
|
|
|
|
Topics
|
|
======
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
getting_started
|
|
dev_get_started
|
|
specs
|
|
|
|
|
|
.. _gerrit: https://review.openstack.org/#/q/status:open+AND+project:openstack/js-openstack-lib,n,z
|
|
.. _#openstack-javascript: http://webchat.freenode.net/?channels=openstack-javascript
|