Updated documentation

PainterQubits · Oct 24, 2016 · 43952e4 · 43952e4
1 parent 11903b0
commit 43952e4
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 17 deletions.
diff --git a/docs/build/config.md b/docs/build/config.md
@@ -26,7 +26,7 @@ If new instrument kinds are added to `deps/instrumentkinds.json`, they will be a
 If new users are added to `deps/users.json`, they will be "upserted" into the `users` table (users are created if necessary; if an existing user name is attempted to be inserted into the table, then that user has their info updated from the json file). Existing users not found in users.json remain in the table.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/setup.jl#L1-L25' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/setup.jl#L1-L25' class='documenter-source'>source</a><br>
 
 
 <a id='deps/config.json-1'></a>

diff --git a/docs/build/index.md b/docs/build/index.md
@@ -31,8 +31,7 @@ Estimated burden: twenty minutes.
       * Server: `localhost`
       * Port: `5432` (or whatever you chose during PostgreSQL installation)
       * Username and password as installed. Ideally a different user would be created.
-
-
+  * Install ICCommon. This package provides basic definitions that should be shared by the InstrumentControl and ICDataServer packages, which may be running on separate processes or even separate computers: `Pkg.clone("https://github.com/painterqubits/ICCommon.jl.git")`
   * Install ICDataServer: `Pkg.clone("https://github.com/painterqubits/ICDataServer.jl.git")`
 
 

diff --git a/docs/build/instruments.md b/docs/build/instruments.md
@@ -16,7 +16,7 @@ newinstrument(dsn, alias; make="", model="", serialnum="", kind="",
 Create a new instrument named `alias` in the `instruments` table.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/instruments.jl#L1-L8' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/instruments.jl#L1-L8' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.updateinstrument' href='#ICDataServer.updateinstrument'>#</a>
 **`ICDataServer.updateinstrument`** &mdash; *Function*.
@@ -30,7 +30,7 @@ updateinstrument(dsn, alias; kwargs...)
 Update any of the fields for an instrument named `alias`. Possible keyword arguments listed in documentation for [`ICDataServer.newinstrument`](instruments.md#ICDataServer.newinstrument).
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/instruments.jl#L18-L25' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/instruments.jl#L18-L25' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.deleteinstrument' href='#ICDataServer.deleteinstrument'>#</a>
 **`ICDataServer.deleteinstrument`** &mdash; *Function*.
@@ -44,7 +44,7 @@ deleteinstrument(dsn, alias)
 Delete instrument named `alias` from the `instruments` table.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/instruments.jl#L32-L38' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/instruments.jl#L32-L38' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.listinstruments' href='#ICDataServer.listinstruments'>#</a>
 **`ICDataServer.listinstruments`** &mdash; *Function*.
@@ -58,7 +58,7 @@ listinstruments(dsn)
 List instruments in the `instruments` table.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/instruments.jl#L44-L50' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/instruments.jl#L44-L50' class='documenter-source'>source</a><br>
 
 
 <a id='Constraints-on-the-instruments-table-1'></a>

diff --git a/docs/build/jobs.md b/docs/build/jobs.md
@@ -11,7 +11,7 @@ newjob(dsn; cryostat="", username="", device="",
 Create a new job in the `jobs` table. This function will return a `DataFrame` containing the columns `job_id` and `jobsubmit` with the inserted job id and job submission time.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/jobs.jl#L7-L16' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/jobs.jl#L7-L16' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.updatejob' href='#ICDataServer.updatejob'>#</a>
 **`ICDataServer.updatejob`** &mdash; *Function*.
@@ -25,5 +25,5 @@ updatejob(dsn, job_id; kwargs...)
 Update an existing job in the `jobs` table based on its `job_id`. Specify the fields to update with keyword arguments specified in [`ICDataServer.newjob`](jobs.md#ICDataServer.newjob).
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/jobs.jl#L31-L39' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/jobs.jl#L31-L39' class='documenter-source'>source</a><br>
 
diff --git a/docs/build/servers.md b/docs/build/servers.md
@@ -10,7 +10,7 @@ newserver(dsn, name, addr, port::Integer=-1)
 Create a new server in the `servers` table.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/servers.jl#L1-L7' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/servers.jl#L1-L7' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.updateserver' href='#ICDataServer.updateserver'>#</a>
 **`ICDataServer.updateserver`** &mdash; *Function*.
@@ -24,7 +24,7 @@ updateserver(dsn, name; kwargs...)
 Update a server in the `servers` table using keyword arguments (`name`, `address`, `port`).
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/servers.jl#L20-L27' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/servers.jl#L20-L27' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.deleteserver' href='#ICDataServer.deleteserver'>#</a>
 **`ICDataServer.deleteserver`** &mdash; *Function*.
@@ -38,7 +38,7 @@ deleteserver(dsn, name)
 Remove a server from the `servers` table by passing its `name`.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/servers.jl#L36-L42' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/servers.jl#L36-L42' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.listservers' href='#ICDataServer.listservers'>#</a>
 **`ICDataServer.listservers`** &mdash; *Function*.
@@ -52,5 +52,5 @@ listservers(dsn, name)
 List all servers in the `servers` table.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/servers.jl#L47-L53' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/servers.jl#L47-L53' class='documenter-source'>source</a><br>
 
diff --git a/docs/build/users.md b/docs/build/users.md
@@ -10,7 +10,7 @@ newuser(dsn, username, name; email="", phone="", office="")
 This function creates a new user in the `users` table of the database. E-mail, phone, office are useful for contacting users about their measurements.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/users.jl#L1-L8' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/users.jl#L1-L8' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.updateuser' href='#ICDataServer.updateuser'>#</a>
 **`ICDataServer.updateuser`** &mdash; *Function*.
@@ -24,7 +24,7 @@ updateuser(dsn, username; kwargs...)
 Update an existing user in the `users` table, identified by `username`. Specify the fields to update with keyword arguments specified in [`ICDataServer.newuser`](users.md#ICDataServer.newuser).
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/users.jl#L30-L38' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/users.jl#L30-L38' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.deleteuser' href='#ICDataServer.deleteuser'>#</a>
 **`ICDataServer.deleteuser`** &mdash; *Function*.
@@ -38,7 +38,7 @@ deleteuser(dsn, username)
 Delete a user from the `users` table by providing the username.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/users.jl#L47-L53' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/users.jl#L47-L53' class='documenter-source'>source</a><br>
 
 <a id='ICDataServer.listusers' href='#ICDataServer.listusers'>#</a>
 **`ICDataServer.listusers`** &mdash; *Function*.
@@ -52,5 +52,5 @@ listusers(dsn)
 List all users in the `users` table.
 
 
-<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/514403a46b775984394168023f072cf132e1384b/src/users.jl#L58-L64' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/PainterQubits/ICDataServer.jl/tree/11903b0154a7a722d12cec3a524d64803928adfe/src/users.jl#L58-L64' class='documenter-source'>source</a><br>
 
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -38,6 +38,10 @@ Estimated burden: twenty minutes.
   + Port: `5432` (or whatever you chose during PostgreSQL installation)
   + Username and password as installed. Ideally a different user would be created.
 
++ Install ICCommon. This package provides basic definitions that should be shared
+  by the InstrumentControl and ICDataServer packages, which may be running on
+  separate processes or even separate computers:
+  `Pkg.clone("https://github.com/painterqubits/ICCommon.jl.git")`
 
 + Install ICDataServer: `Pkg.clone("https://github.com/painterqubits/ICDataServer.jl.git")`