openstack/swift
Code Issues Proposed changes

Updated Sphinx theme and index.rst

Browse Source
This commit is contained in:
Anne Gentle 2010-11-12 12:54:07 -06:00
parent ce0a0be664
commit 4aa104e49e
2 changed files with 35 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/conf.py
View File

@ -114,7 +114,9 @@ modindex_common_prefix = ['swift.']
# The theme to use for HTML and HTML Help pages. Major themes that come with # The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'. # Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'default' # html_theme = 'default'
html_theme_path = ["."]
html_theme = '_theme'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the

42
doc/source/index.rst
View File

@ -1,20 +1,38 @@
.. Swift documentation master file, created by ..
sphinx-quickstart on Tue May 18 13:50:15 2010. Copyright 2010 OpenStack LLC
You can adapt this file completely to your liking, but it should at least All Rights Reserved.
contain the root `toctree` directive.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Welcome to Swift's documentation! Welcome to Swift's documentation!
================================= =================================
Swift is a highly available, distributed, eventually consistent object/blob Swift is a highly available, distributed, eventually consistent object/blob
store. store. Organizations can use Swift to store lots of data efficiently, safely, and cheaply.
This documentation is generated by the Sphinx toolkit and lives in the source
tree. Additional documentation on Swift and other components of OpenStack can
be found on the `OpenStack wiki`_.
.. _`OpenStack wiki`: http://wiki.openstack.org
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
getting_started getting_started
Overview: Overview and Concepts
=====================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -27,7 +45,8 @@ Overview:
overview_stats overview_stats
ratelimit ratelimit
Development: Developer Documentation
=======================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -36,7 +55,8 @@ Development:
development_saio development_saio
development_auth development_auth
Deployment: Administrator Documentation
===========================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -46,14 +66,16 @@ Deployment:
admin_guide admin_guide
debian_package_guide debian_package_guide
End User Guides: End User Guides
===============
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
howto_cyberduck howto_cyberduck
Source: Source Documentation
====================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2