-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ported docs to Sphinx and set up RTFD
- Loading branch information
Showing
10 changed files
with
346 additions
and
153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
======= | ||
AgaveDB | ||
======= | ||
|
||
.. image:: https://badge.fury.io/py/agavedb.svg | ||
:target: http://badge.fury.io/py/agavedb | ||
|
||
.. image:: https://travis-ci.org/TACC/agavedb.svg?branch=master | ||
:target: https://travis-ci.org/TACC/agavedb | ||
|
||
.. image:: https://readthedocs.org/projects/agavedb/badge/?version=latest | ||
:target: https://readthedocs.org/projects/agavedb/?badge=latest | ||
|
||
.. image:: https://img.shields.io/pypi/l/Django.svg | ||
:target: https://raw.githubusercontent.com/TACC/agavedb/master/LICENSE | ||
|
||
**Multiuser-aware key/value store built using the Agave metadata API** | ||
|
||
- Documentation: https://agavedb.readthedocs.io/en/latest/ | ||
- GitHub: https://github.com/TACC/agavedb | ||
- PyPI: https://pypi.python.org/pypi/agavedb | ||
- Free software: 3-Clause BSD License | ||
|
||
Installation | ||
============ | ||
|
||
Install from PyPI_:: | ||
|
||
pip install agavedb | ||
|
||
|
||
Install from GitHub checkout:: | ||
|
||
cd agavedb | ||
python setup.py install | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Minimal makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line. | ||
SPHINXOPTS = | ||
SPHINXBUILD = python -msphinx | ||
SPHINXPROJ = AgaveDB | ||
SOURCEDIR = . | ||
BUILDDIR = _build | ||
|
||
# Put it first so that "make" without argument is like "make help". | ||
help: | ||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: help Makefile | ||
|
||
# Catch-all target: route all unknown targets to Sphinx using the new | ||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
%: Makefile | ||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.