DOC: Centralize documentation.md

bluesky · Apr 7, 2020 · 8b40841 · 8b40841
1 parent 2da8318
commit 8b40841
Show file tree

Hide file tree

Showing 12 changed files with 19 additions and 302 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -17,4 +17,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,7 @@
+# suitcase-jsonl changes
+
+## v0.2.0 (2019-05-28)
+
+## v0.1.1 (2019-03-07)
+
+## v0.1.0 (2019-03-07)
diff --git a/README.md b/README.md
@@ -7,3 +7,15 @@ This is a suitcase subpackage for reading a particular file format.
 ```
 pip install suitcase-jsonl
 ```
+
+## Quick Start
+
+```
+import suitcase.jsonl
+docs = db[-1].documents(fill=True)
+suitcase.jsonl.export(docs, 'my_exported_files/', file_prefix='PREFIX-')
+```
+
+## 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
@@ -6,11 +6,4 @@ flake8
 # TEMPORARY UNTIL https://github.com/NSLS-II/ophyd/pull/682 IS RELEASED
 git+git://github.com/NSLS-II/ophyd@ophyd-for-suitcase-utils
 pytest >=3.9
-sphinx
 suitcase-utils[test_fixtures] >=0.1.4rc1
-# These are dependencies of various sphinx extensions for documentation.
-ipython
-matplotlib
-numpydoc
-sphinx-copybutton
-sphinx_rtd_theme