Skip to content

Commit

Permalink
Ported docs to Sphinx and set up RTFD
Browse files Browse the repository at this point in the history
  • Loading branch information
mwvaughn committed Feb 19, 2018
1 parent 9c7da50 commit a1cc05c
Show file tree
Hide file tree
Showing 10 changed files with 346 additions and 153 deletions.
8 changes: 5 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@ sdist: dist-clean
make clean

docs:
cd scripts && \
bash docs.sh
cd docs && \
make html

install:
python setup.py install

clean:
rm -rf agavedb/tests/*pyc agavedb/*pyc agavedb.egg-info build/ .cache agavedb/tests/__pycache__ .pytest_cache
rm -rf agavedb/tests/*pyc agavedb/*pyc agavedb.egg-info build/ .cache agavedb/tests/__pycache__ .pytest_cache && \
cd docs && \
make clean

dist-clean: clean
rm -rf dist
Expand Down
90 changes: 0 additions & 90 deletions README.md

This file was deleted.

36 changes: 36 additions & 0 deletions README.rst
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

20 changes: 20 additions & 0 deletions docs/Makefile
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)
55 changes: 0 additions & 55 deletions docs/api.md

This file was deleted.

0 comments on commit a1cc05c

Please sign in to comment.