Sub-Section¶

Uses h3 headings and is used for a sub-section. If the chapter consists of numerous sections, use this to help break it down further, such as explaining a smaller portion in the overall chapter. Note that we’re using a different heading to help denote that this is a different kind of section. reST has that kind of foresight.

The biggest appeal with this section is that it gives breathing room, but isn’t a large-scale split like the previous one is.

In Summary¶

We hope that this helped demonstrate the hierarchy of sections!

Images¶

An image example:

A figure example:

This is the figure caption. The indentation lets reST realize that this is attached to the image. You should use these instead of direct images when wanting to demonstrate a visual example. There must be a blank line after the figure.

Tables¶

Various table directives are possible too. Here we’ll show two kinds of tables: the default reST table and CSV tables.

But sometimes this formatting is inconvenient to type. So here’s a CSV table. For more details, refer to here.

Cross-Referencing¶

You can cross reference text as well. It works similarly to a GOTO, where you simply label the section you want to redirect, and then refer it like this: Special Formatting Nougats.

There’s a specific naming convention to follow when it comes to creating cross-referencing labels. Because all reference labels are global, a naming conflict is bound to occur, or it can be confusing exactly where you’re going when there’s many pages in the documentation. To fix this, names are based on their subfolders to file then to section name. An example would be storyboarding_scripting_compound_commands_loop.

You can also refer to other documents, such as this example to refer back to the overview page. Meta Content.

For more details, refer to this link.

Admonitions¶

Sometimes in our text, we’d like to write little other blurbs that act as special info bonuses. You’ve seen one earlier with the Note title. Here’s some other blocks you can use! Do note that the only ones that are themed in with this website are listed in this example page, so while other admonitions exist in Sphinx, these are the only ones that are supported.

Code Samples¶

Example of a code-block using C#.

1
2
3
4
5
6
7

public Color4 ColorLerp(Color4 a, Color4 b, float blend)
{
    var vectorColorA = new Vector3(a.R,a.G,a.B);
    var vectorColorB = new Vector3(b.R,b.G,b.B);
    var v = Vector3.Lerp(vectorColorA,vectorColorB,blend);
    return new Color4(v.X,v.Y,v.Z,255);
}

This example demonstrates highlighting a certain line, and also demonstrates starting a line number from a specific spot. (But the specific line is non-relative to the lineno-start value!)

46
47
48

public static int manhattanDistance(Coord a, Coord b) {
              return Math.Abs(b.x - a.x) + Math.Abs (b.y - a.y);
      }

This example demonstrates Python highlighting.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

def search(n):

      def isTooHeavy(cs):
              cs >= success.moves

      x = int(n)
      pq = PriorityQueue()
      pq.push( PelletState(x), 0 )
      visited = []
      success = PelletState(1, 99999999)

      while pq._queue:
              currentState = pq.pop()
              # print( str(currentState.moves) )
              if not (currentState in visited) and currentState.moves <= success.moves:
                      visited.append(currentState)
                      if currentState.pellets == 1:
                              return currentState
                              # success = currentState if currentState.moves < success.moves else success
                      else:
                              if not isTooHeavy(currentState.moves+1):
                                      if not currentState.addFlag:
                                              pq.push( currentState.AddOne(), currentState.moves+1 )
                                      if currentState.pellets % 2 == 0:
                                              pq.push( currentState.DivideGroup(), currentState.moves+1  )
                                      pq.push( currentState.RemoveOne(), currentState.moves+1 )

      return success