diff --git a/doc/source/_static/tweaks.css b/doc/source/_static/tweaks.css new file mode 100644 index 0000000000..16cd6e76e2 --- /dev/null +++ b/doc/source/_static/tweaks.css @@ -0,0 +1,65 @@ +ul.todo_list { + list-style-type: none; + margin: 0; + padding: 0; +} + +ul.todo_list li { + display: block; + margin: 0; + padding: 7px 0; + border-top: 1px solid #eee; +} + +ul.todo_list li p { + display: inline; +} + +ul.todo_list li p.link { + font-weight: bold; +} + +ul.todo_list li p.details { + font-style: italic; +} + +ul.todo_list li { +} + +div.admonition { + border: 1px solid #8F1000; +} + +div.admonition p.admonition-title { + background-color: #8F1000; + border-bottom: 1px solid #8E8E8E; +} + +a { + color: #CF2F19; +} + +div.related ul li a { + color: #CF2F19; +} + +div.sphinxsidebar h4 { + background-color:#8E8E8E; + border:1px solid #255E6E; + color:white; + font-size:1em; + margin:1em 0 0.5em; + padding:0.1em 0 0.1em 0.5em; +} + +em { + font-style: normal; +} + +table.docutils { + font-size: 11px; +} + +a tt { + color:#CF2F19; +} \ No newline at end of file diff --git a/doc/source/_theme/layout.html b/doc/source/_theme/layout.html new file mode 100644 index 0000000000..ed1cab0a6e --- /dev/null +++ b/doc/source/_theme/layout.html @@ -0,0 +1,2 @@ +{% extends "sphinxdoc/layout.html" %} +{% set css_files = css_files + ['_static/tweaks.css'] %} diff --git a/doc/source/_theme/theme.conf b/doc/source/_theme/theme.conf new file mode 100644 index 0000000000..e039fe01f9 --- /dev/null +++ b/doc/source/_theme/theme.conf @@ -0,0 +1,5 @@ +[theme] +inherit = sphinxdoc +stylesheet = sphinxdoc.css +pygments_style = friendly + diff --git a/doc/source/conf.py b/doc/source/conf.py index 78b662c8a3..74dfce9947 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -114,7 +114,9 @@ modindex_common_prefix = ['swift.'] # The theme to use for HTML and HTML Help pages. Major themes that come with # 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 # further. For a list of options available for each theme, see the diff --git a/doc/source/index.rst b/doc/source/index.rst index 854aa4c64d..9b20293921 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,20 +1,38 @@ -.. Swift documentation master file, created by - sphinx-quickstart on Tue May 18 13:50:15 2010. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. + Copyright 2010 OpenStack LLC + All Rights Reserved. + 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! ================================= 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:: :maxdepth: 1 getting_started -Overview: +Overview and Concepts +===================== .. toctree:: :maxdepth: 1 @@ -27,7 +45,8 @@ Overview: overview_stats ratelimit -Development: +Developer Documentation +======================= .. toctree:: :maxdepth: 1 @@ -36,7 +55,8 @@ Development: development_saio development_auth -Deployment: +Administrator Documentation +=========================== .. toctree:: :maxdepth: 1 @@ -46,14 +66,16 @@ Deployment: admin_guide debian_package_guide -End User Guides: +End User Guides +=============== .. toctree:: :maxdepth: 1 howto_cyberduck -Source: +Source Documentation +==================== .. toctree:: :maxdepth: 2