DOC: Centralize documentation.md

bluesky · Apr 6, 2020 · 13698df · 13698df
1 parent c938bae
commit 13698df
Show file tree

Hide file tree

Showing 12 changed files with 42 additions and 302 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -19,4 +19,3 @@ script:
   - coverage report -m  # Generate test coverage report.
   - codecov  # Upload the report to codecov.
   - flake8 --max-line-length=115  # Enforce code style (but relax line length limit a bit).
-  - make -C docs html  # Build the documentation.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+# suitcase-mongo changes
+
+## v0.2.0 (2020-03-13)
+
+## v0.1.2 (2020-03-11)
+
+## v0.1.1 (2019-10-18)
+
+## v0.1.0 (2019-05-03)
diff --git a/README.md b/README.md
@@ -15,3 +15,36 @@ contains two packages:
 ```
 pip install suitcase-mongo
 ```
+
+## Quick Start
+
+`suitcase-mongo` supports `mongo_normalized` and `mongo_embedded`.
+
+Using `mongo_normalized`:
+
+```
+from suitcase.mongo_normalized import Serializer
+docs = db[-1].documents(fill=True)
+serializer = Serializer(METADATASTORE_DB, ASSET_REGISTRY_DB)
+for item in documents:
+  serializer(*item)
+```
+
+Using `mongo_embedded`:
+
+```
+from suitcase.mongo_normalized import Serializer
+import event_model
+
+docs = db[-1].documents(fill=True)
+serializer = Serializer(PERMANENT_DB)
+for item in docs:
+  # Fix formatting for JSON.
+  item = event_model.sanitize_doc(item)
+  # Send the bluesky doc to the serializer
+  serializer(*item)
+```
+
+## Documentation
+
+See the [suitcase documentation](https://nsls-ii.github.io/suitcase).
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/source/_static/.placeholder b/docs/source/_static/.placeholder
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -5,13 +5,6 @@ codecov
 coverage
 flake8
 pytest >=3.9
-sphinx
 suitcase-utils[test_fixtures] >=0.1.0rc2
-# These are dependencies of various sphinx extensions for documentation.
-ipython
-matplotlib
-numpydoc
-sphinx-copybutton
-sphinx_rtd_theme
 # TEMPORARY UNTIL https://github.com/NSLS-II/ophyd/pull/682 IS RELEASED
 git+git://github.com/NSLS-II/ophyd@ophyd-for-suitcase-utils