Documentation structure update

[rheone]

Addresses #21 fixes Sphinx document template width
Addresses #22 Converting Sphinx markdown documentation to restructured text

Attached is compiled docs html.zip

[ahsteele]

I haven’t looked at the diffs yet, but does this conform to a standard for HTML heading markup?

[rheone]

RestructuredText you mean?
The headings are “correct” but likely not consistent per document. Such can be amended before completion.

[rheone]

@ahsteele The RestructuredText headings are now normalized as per Sphinx and RST syntax guide (0.9.3)

• # with overline, for parts
• * with overline, for chapters
• =, for sections
• -, for subsections
• ^, for subsubsections
• “, for paragraphs

Adds build docs

Added a new Building page to docs so as other developers can also build the project and doc and their machines. hint hint This covers the the optional use of psake, building docs and building c# code and generating packages via command line.

See attached zip for rendered docs

html.zip

[ahsteele]

Would it be helpful to use the same unsigned integer from the big-Endian example? That way people can “see” the difference?

[rheone]

Sure, I can do that. I was just trying to switch up values to make things more "interesting".
I'll drop the B-52's and reuse Jenny.

[rheone]

Fixed in push e3978c3cb3acfbf4bc06f74bd9518b92edabf965.

Apparently I did a bad job with my Decimal to Hex conversion. That too is correctedDecimal to Hex conversion of 8675309. Also, just for fun, added latex notation to doc.

[ahsteele]

Should we put this somewhere in the documentation or other guidelines so that we can refer back to it? I know I’ll have to look it up and shipping it with the project will be easier than Google for the syntax guide each time.

The RestructuredText headings are now normalized as per Sphinx and RST syntax guide (0.9.3)

• # with overline, for parts
• * with overline, for chapters
• =, for sections
• -, for subsections
• ^, for subsubsections
• “, for paragraphs

[rheone]

Should we put this somewhere in the documentation or other guidelines so that we can refer back to it? I know I’ll have to look it up and shipping it with the project will be easier than Google for the syntax guide each time.

The RestructuredText headings are now normalized as per Sphinx and RST syntax guide (0.9.3)

• # with overline, for parts
• * with overline, for chapters
• =, for sections
• -, for subsections
• ^, for subsubsections
• “, for paragraphs

I'm ready to write a style guideline, nor am I sure I ever will be. I think that's where the heading stuff would belong. I'll open an issue for a style guide and include the heading ordering. We can use that as a stop gap for the moment until something more "official" is created.

See #27 [Doc] Create a style guideline