aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorchrislusf <chris.lu@gmail.com>2014-07-23 11:00:38 -0700
committerchrislusf <chris.lu@gmail.com>2014-07-23 11:00:38 -0700
commit4b97358100a83363e242999b3467c0f7694e9dfa (patch)
treefe9e8d565e6264c0f0156ad5380416421708487d /docs/index.rst
parentdc03626167a3e5d5ea0f97b260e53057f447a97d (diff)
parentc65a9f5639801b72d23fc27f0b8f79f5959b37d5 (diff)
downloadseaweedfs-4b97358100a83363e242999b3467c0f7694e9dfa.tar.xz
seaweedfs-4b97358100a83363e242999b3467c0f7694e9dfa.zip
Merge pull request #7 from ernado/master
Read the docs integration
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 000000000..800e9c3f4
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,43 @@
+.. weed-fs documentation master file, created by
+ sphinx-quickstart on Wed Jul 23 12:13:18 2014.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to weed-fs's documentation!
+===================================
+
+An official mirror of code.google.com/p/weed-fs .
+Moving to github.com to make cooperations easier.
+This repo and the google code repo will be kept synchronized.
+
+
+For documents and bug reporting, Please visit
+ http://weed-fs.googlecode.com
+
+For pre-compiled releases,
+ https://bintray.com/chrislusf/Weed-FS/weed
+
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ gettingstarted
+ clients
+ api
+ replication
+ failover
+ usecases
+ directories
+ optimization
+ benchmarks
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+