Sphinx Notes

Internal Sphinx notes and experiments.

MATCH (?x)->(?y)
RETURN ?x, ?y
MatCH (?x)->(?y) "MATCH \t asdf"
SIMPLE

Top-level section

Sub-section

Sub-sub-section

Documentation links

References

code: reference which only works in the same document.
CODE: reference with custom title.
Sub-section: reference to a sub-section by name.
Code blocks: reference to a target with spaces.
This is an auto-numbered footnote [1]
This is another auto-numbered footnote [2]
This is an auto-symbol footnote [*]
This is another auto-symbol footnote [†]
This is a labeled footnote [3]
This is a labeled footnote [PaperX]
This is a sphinx extension that creates a reference that works across documents: Code blocks. :ref: is a role,
You can also customize the title: title. :ref: is a role,
URL: inline link with custom title.
http://google.com inline link
a link to google

[PaperX]

This is a footnote

Code blocks

Using directives

@prefix : <http://example.org/> .
@prefix foaf:       <http://xmlns.com/foaf/0.1/> .

:a foaf:name "Alan" .
:a foaf:mbox <mailto:alan@example.org> .
:b foaf:name "Bob" .
:b foaf:mbox <mailto:bob@example.org> .
:c foaf:name "Claire" .
:c foaf:mbox <mailto:claire@example.org> .
:a foaf:knows :b .
:b foaf:knows :c .

def function(num: int):
  if num < 3:
    return True
  else:
    yield 2 * num

int my_fun(double num) {
  if (num > 4) {
    return 3;
  } else if (num.is_something()) {
    return -1;
  }
}

SELECT *
WHERE {
  ?s ?p ?o .
  FILTER (STRLEN(?o) > 4)
}
ORDER BY ?o
LIMIT 10

enumerate(sequence)
enumerate(sequence[, start=0]): Return an iterator that yields tuples of an index and an item of the sequence. (And so on.)

int mult(int a, int b): Return a * b.

Inline

without syntax highlighting: var = obj.method(3 * 5, "string") if True else "stuff".
with syntax highlighting: var = obj.method(3 * 5, "string") if True else "stuff".
with syntax highlighting: FILTER ?x = "string".

Literal blocks

A literal block follow:

literal block
       indentation is preserved
  notice the single colon True

another block, without preceding paragraph

Some paragraph

A block following a paragraph without a colon

Admonitions

Admonition

admonition

Note

note

Hint

hint

Important

important

Tip

tip

Attention

attention

Caution

caution

Warning

warning

Danger

danger

Error

error