This GitHub repository contains the source files for the following Rackspace Cloud Block Storage API documentation:
Contributions are welcome!
-
To suggest changes or report a problem, submit an issue.
-
To make changes to a project, create your own fork of the repository. Then, submit a pull request to have your changes reviewed and merged into the master branch as appropriate.
To contribute content, all you need is an editor and a basic understanding of the project layout and reStructuredText syntax.
You can use the GitHub editor or any text editor to work with documentation source files. For quick syntax checking, try the Online restructuredText editor.
Note: If you want to build the project, you need to install the Sphinx documentation generator.
The Rackspace developer documentation is developed and built using the Python Sphinx documentation generator. Content is written in reStructuredText, the markup syntax and parser component of Python Docutils.
The repository includes the documentation source files, Sphinx configuration and build files, as well any required Sphinx extensions and build tools.
Source files for the Sphinx documentation project are in the rst/dev-guide directory. Here are the key files that define
the Sphinx project and content architecture for the documentation:
| Content | File |
|---|---|
| Sphinx documentation configuration file | conf.py (Typically, this file does not require changes.) |
| Index page for the main content structure | index.rst |
| Getting started | getting-started folder |
| General API information | general-api-info folder |
| API reference | api-reference folder |
| API reference methods, including code samples | api-reference/methods |
| Release notes | release-notes folder |
|make.bat|Windows build script |Makefile| Linux and OS X build
If you find a problem, open a GitHub issue.
If you need additional assistance, contact us at [email protected].