astrocalc.docstring_test module ∞

Testing the rendering of docstings - feel free to remove this module

Check the API output here: file:///Users/Dave/git_repos/templates/python-package-template/astrocalc/docs/build/html/_api/astrocalc.docstring_test.html

docsting_test(self)[source] ∞

the database object for sherlock, setting up ssh tunnels and various database connections

The returned dictionary of database connections contain the following databases:

  • transients – the database hosting the transient source data

  • catalogues – connection to the database hosting the contextual catalogues the transients are to be crossmatched against

  • marshall – connection to the PESSTO Marshall database

Key Arguments

  • log – logger

  • settings – the settings dictionary

Return

  • dbConns – a dictionary of the database connections required by sherlock

Usage

To setup the sherlock database connections, run the following:

# SETUP ALL DATABASE CONNECTIONS
from sherlock import database
db = database(
    log=log,
    settings=settings
)
dbConns, dbVersions = db.connect()
transientsDbConn = dbConns["transients"]
cataloguesDbConn = dbConns["catalogues"]
pmDbConn = dbConns["marshall"]

Todo

  • update key arguments values and definitions with defaults

  • update return values and definitions

  • update usage examples and text

  • update docstring text

  • check sublime snippet exists

  • clip any useful text to docs mindmap

  • regenerate the docs and check redendering of this docstring

Embed reStructuredText

Todo

  • nice!

Code and Syntax Highlighting

Inline code has back-ticks around it.

var s = "JavaScript syntax highlighting";
alert(s);

s = "Python syntax highlighting"
print(s)
myString = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

No language indicated, so no syntax highlighting. 
But let's throw in a <b>tag</b>.

Mermaid

gantt
        dateFormat  YYYY-MM-DD
        title Adding GANTT diagram functionality to mermaid
        section A section
        Completed task            :done,    des1, 2014-01-06,2014-01-08
        Active task               :active,  des2, 2014-01-09, 3d
        Future task               :         des3, after des2, 5d
        Future task2               :         des4, after des3, 5d
        section Critical tasks
        Completed task in the critical line :crit, done, 2014-01-06,24h
        Implement parser and jison          :crit, done, after des1, 2d
        Create tests for parser             :crit, active, 3d
        Future task in critical line        :crit, 5d
        Create tests for renderer           :2d
        Add to mermaid                      :1d

Flowchart

s=>start: start
e=>end: end
o=>operation: operation
sr=>subroutine: subroutine
c=>condition: condition
i=>inputoutput: inputoutput
p=>parallel: parallel

s->o->c
c(yes)->i->e
c(no)->p
p(path1, bottom)->sr(right)->o
p(path2, top)->o

Tables

Colons can be used to align columns.

Tables

Are

Cool

col 3 is

right-aligned

$1600

col 2 is

centered

$12

zebra stripes

are neat

$1

Definitions

term

definition

what

Definition lists associate a term with a definition.

Math

A formula, \({e}^{i\pi }+1=0\), inside a paragraph.

$${e}^{ipi }+1=0$$

Super/Sub Scripts

m2

x2,y

xz

C6H12O6

Citations

Cite a source.[p. 42]1

Black (2015)2

Task Lists

  • [x] Completed task item

  • [ ] Unfinished task item

Footnote

Here’s a sentence with a footnote3 in the middle of it!

Emphasis

Emphasis, aka italics, with asterisks

Strong emphasis, aka bold, with asterisks.

Strikethrough .

Lists

  1. First ordered list item

  2. Another item

    • Unordered sub-list.

  3. Actual numbers don’t matter, just that it’s a number

    1. Ordered sub-list

  4. And another item.

    You can have properly indented paragraphs within list items.

and unordered lists:

  • Unordered list can use asterisks

  • Or minuses

  • Or pluses

Links

I’m an inline-style link

Images

Here’s our logo (hover to see the title text):

Inline-style:

alt text

Reference-style:

alt text

Blockquotes

Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let’s keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.

Abbreviations

The HTML specification is maintained by the W3C.

[HTML]: Hyper Text Markup Language[W3C]: World Wide Web Consortium

Horizontal Rule

Three or more…

Hyphens

1

John Doe. A Totally Fake Book. Vanity Press, 2006.

2

A Bryden Black 2015, The Lion, the Dove, & the Lamb, Wipf and Stock Publishers

3

This is the footnote.