Skip to content

Commit

Permalink
DOC: Centralize documentation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ke-zhang-rd committed Apr 2, 2020
1 parent c938bae commit c8eac7e
Show file tree
Hide file tree
Showing 12 changed files with 30 additions and 302 deletions.
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# 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)

## v0.1.0rc1 (2019-04-24)

## v0.1.0b5 (2019-04-02)

## v0.1.0b4 (2019-02-14)

## v0.1.0b3 (2019-02-14)

## v0.1.0b2 (2019-02-13)

## v0.1.0b1 (2019-02-08)

8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,11 @@ contains two packages:
```
pip install suitcase-mongo
```

## Quick Start

TODO

## Documentation

See the [suitcase documentation](https://nsls-ii.github.io/suitcase).
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

36 changes: 0 additions & 36 deletions docs/make.bat

This file was deleted.

Empty file removed docs/source/_static/.placeholder
Empty file.
202 changes: 0 additions & 202 deletions docs/source/conf.py

This file was deleted.

14 changes: 0 additions & 14 deletions docs/source/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/installation.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/release-history.rst

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/usage.rst

This file was deleted.

7 changes: 0 additions & 7 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit c8eac7e

Please sign in to comment.