From 2fd71c87d6e29eacb7a546e13602c73132afab14 Mon Sep 17 00:00:00 2001 From: Fabian Sinz Date: Fri, 8 May 2015 17:20:00 -0500 Subject: [PATCH] changed name in documentation --- doc/Makefile | 4 --- doc/source/Getting started.rst | 27 --------------- doc/source/base.rst | 5 --- doc/source/connection.rst | 4 +-- doc/source/index.rst | 11 ++---- doc/source/relation.rst | 5 +++ doc/source/relational.rst | 6 ---- doc/source/relational_operand.rst | 6 ++++ tutorials/Getting started.ipynb | 56 ------------------------------- 9 files changed, 15 insertions(+), 109 deletions(-) delete mode 100644 doc/source/Getting started.rst delete mode 100644 doc/source/base.rst create mode 100644 doc/source/relation.rst delete mode 100644 doc/source/relational.rst create mode 100644 doc/source/relational_operand.rst delete mode 100644 tutorials/Getting started.ipynb diff --git a/doc/Makefile b/doc/Makefile index 2f6f7ccc6..a50666355 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -49,10 +49,6 @@ help: clean: rm -rf $(BUILDDIR)/* -tutorials: - cd source; ipython nbconvert --to rst "../../tutorials/*.ipynb" - - html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo diff --git a/doc/source/Getting started.rst b/doc/source/Getting started.rst deleted file mode 100644 index d009c53b2..000000000 --- a/doc/source/Getting started.rst +++ /dev/null @@ -1,27 +0,0 @@ - -Create a database object -======================== - -First, import datajoint, set environmental variables and define the -database. The definition of the database is usually done in another -file. - -This tests some latex :math:`x \mapsto y`. - -.. code:: python - - from os import environ - environ.get('DJ_HOST', 'localhost') - environ.get('DJ_USER', 'datajoint') - environ.get('DJ_PASSW', 'datajoint') - import datajoint as dj - - class Subjects(dj.Relation): - _table_def = """ - Subjects (manual) # Basic subject info - - subject_id : int # unique subject id - --- - real_id : varchar(40) # real-world name - species = "mouse" : enum('mouse', 'monkey', 'human') # species - """ diff --git a/doc/source/base.rst b/doc/source/base.rst deleted file mode 100644 index 767e284b1..000000000 --- a/doc/source/base.rst +++ /dev/null @@ -1,5 +0,0 @@ -Relation -==== - -.. automodule:: datajoint.base - :members: diff --git a/doc/source/connection.rst b/doc/source/connection.rst index 3e177fb3a..dbc55b73f 100644 --- a/doc/source/connection.rst +++ b/doc/source/connection.rst @@ -2,5 +2,5 @@ Connection ========== .. automodule:: datajoint.connection -:members: - :inherited-members: + :members: + :inherited-members: diff --git a/doc/source/index.rst b/doc/source/index.rst index cf57dd954..b02acdad1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,20 +6,13 @@ Welcome to datajoint's documentation! ===================================== -Tutorials: - -.. toctree:: - :maxdepth: 2 - - Getting started.rst - API: .. toctree:: :maxdepth: 2 - base.rst - relational.rst + relation.rst + relational_operand.rst connection.rst diff --git a/doc/source/relation.rst b/doc/source/relation.rst new file mode 100644 index 000000000..724375453 --- /dev/null +++ b/doc/source/relation.rst @@ -0,0 +1,5 @@ +Relation +======== + +.. automodule:: datajoint.relation + :members: diff --git a/doc/source/relational.rst b/doc/source/relational.rst deleted file mode 100644 index c520ef34f..000000000 --- a/doc/source/relational.rst +++ /dev/null @@ -1,6 +0,0 @@ -Relational -========== - -.. automodule:: datajoint.relational -:members: - :inherited-members: diff --git a/doc/source/relational_operand.rst b/doc/source/relational_operand.rst new file mode 100644 index 000000000..c8901c733 --- /dev/null +++ b/doc/source/relational_operand.rst @@ -0,0 +1,6 @@ +Relational operand +================== + +.. automodule:: datajoint.relational_operand + :members: + :inherited-members: diff --git a/tutorials/Getting started.ipynb b/tutorials/Getting started.ipynb deleted file mode 100644 index 8aff186b8..000000000 --- a/tutorials/Getting started.ipynb +++ /dev/null @@ -1,56 +0,0 @@ -{ - "metadata": { - "name": "" - }, - "nbformat": 3, - "nbformat_minor": 0, - "worksheets": [ - { - "cells": [ - { - "cell_type": "heading", - "level": 1, - "metadata": {}, - "source": [ - "Create a database object" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "First, import datajoint, set environmental variables and define the database. The definition of the database is usually done in another file. \n", - "\n", - "This tests some latex $x \\mapsto y$." - ] - }, - { - "cell_type": "code", - "collapsed": false, - "input": [ - "from os import environ\n", - "environ.get('DJ_HOST', 'localhost')\n", - "environ.get('DJ_USER', 'datajoint')\n", - "environ.get('DJ_PASSW', 'datajoint')\n", - "import datajoint as dj\n", - "\n", - "class Subjects(dj.Base):\n", - " _table_def = \"\"\"\n", - " Subjects (manual) # Basic subject info\n", - "\n", - " subject_id : int # unique subject id\n", - " ---\n", - " real_id : varchar(40) # real-world name\n", - " species = \"mouse\" : enum('mouse', 'monkey', 'human') # species\n", - " \"\"\"\n" - ], - "language": "python", - "metadata": {}, - "outputs": [], - "prompt_number": 3 - } - ], - "metadata": {} - } - ] -} \ No newline at end of file