add docs outline

Bauble · Jun 8, 2014 · d67f0f2 · d67f0f2
1 parent aa68648
commit d67f0f2
Show file tree

Hide file tree

Showing 57 changed files with 4,525 additions and 133 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 _site
 .sass-cache
-venv
+venv
+Gemfile.lock
diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
-gem 'github-pages'
+gem 'jekyll'
 gem 'jekyll-sitemap'
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 66b4b4a326a7303e362382650081c15f
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/api.doctree b/docs/.doctrees/api.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/getting_started.doctree b/docs/.doctrees/getting_started.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/new_records.doctree b/docs/.doctrees/new_records.doctree
diff --git a/docs/.doctrees/reports.doctree b/docs/.doctrees/reports.doctree
diff --git a/docs/.doctrees/searching.doctree b/docs/.doctrees/searching.doctree
diff --git a/docs/.doctrees/settings.doctree b/docs/.doctrees/settings.doctree
diff --git a/docs/_sources/api.txt b/docs/_sources/api.txt
@@ -0,0 +1,2 @@
+REST API
+========
diff --git a/docs/_sources/getting_started.txt b/docs/_sources/getting_started.txt
@@ -0,0 +1,13 @@
+Getting Started
+===============
+
+Create a new account
+--------------------
+
+Every account on Bauble is also part of an organization.  Organizations allow more than one user to manage a plant collection.  At the moment there is no way to restrict what a particular user can an can't edit in a collection so only allow someone access to your collection if they are somone you can trust.
+
+.. highlights::
+   The organizations **name** and short **name** are not required
+   to be unique but these field are used when exporting your data.  If your
+   organization is registered with `BGCI<http://bgci.org>` then the short name
+   should be the same as the *Institution Code* registered with the BGCI.
diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt
@@ -0,0 +1,26 @@
+.. Bauble documentation master file, created by
+   sphinx-quickstart on Sat Jun  7 19:40:41 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Bauble's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+
+   getting_started
+   searching
+   new_records
+   reports
+   settings
+   api
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/new_records.txt b/docs/_sources/new_records.txt
@@ -0,0 +1,25 @@
+Creating a new record
+=====================
+
+Family
+------
+
+
+Genus
+------
+
+
+Taxon
+------
+
+
+Accession
+---------
+
+
+Plant
+------
+
+
+Location
+--------
diff --git a/docs/_sources/reports.txt b/docs/_sources/reports.txt
@@ -0,0 +1,2 @@
+Reports
+=======
diff --git a/docs/_sources/searching.txt b/docs/_sources/searching.txt
@@ -0,0 +1,2 @@
+Searching
+=========
diff --git a/docs/_sources/settings.txt b/docs/_sources/settings.txt
@@ -0,0 +1,2 @@
+Settings
+========
diff --git a/docs/_static/ajax-loader.gif b/docs/_static/ajax-loader.gif