Make sure you name your file something that makes the topic clear to yourself and others. Keep in mind that all pages will be arranged alphabetically by filename in the side menu.
The proper extension for a file on this website is .rst. This file is named writing_documentation.rst
Feel free to copy and paste any of the formatting on this file.
Your document must begin with a heading. The heading will appear as the page’s name in the side menu.
Headings appear with equal signs (=) in the rows immediately above and below the text of the heading. Both rows of equal signs must be the same length.
Subheadings appear with hyphens (-) in the rows immediately above and below the text of the subheading. Both rows of hyphens must be the same length.
Third-level headings appear with equal signs (=) in the row immediately below the text of the third-level heading.
The body text does not need any modifications. Just type normally. Text will wrap automatically when it goes online so do not worry about line breaks. To keep text in one paragraph, continue typing on the same line.
If you want to start a new paragraph, press enter twice.
To bold something, add two asterisks (**) at the start and end of the text you want to be bolded.
Here is an example of bolded text.
To add a number, type the number followed by a period at the start of the line.
Start a new line with every new number.
This will create a numbered list.
To add a bullet, type an astrisk (*) at the start of the line.
Start a new line with every new bullet point.
This will create a bulleted list.
To add a link, use the following format:
Home page for TAMU Digital Collections Labs
Do not forget the underscore (_) at the end.
To add an image, the image must first be added to the docs/source/_static/images/ folder. Then enter .. image:: {filepath}.
Press return and on the next line, after adding an indentation enter :alt: {Alt text}.
Use the following format. Make sure everything is aligned exactly.
Column A |
Column B |
Column C |
|---|---|---|
Row 2 |
Cell 2B |
cell 2C |
Row 3 |
Cell 3B |
cell 3C |
To add a note, use the following format:
Note
This is a note.
To add a line of code, type “:code:” followed by two backticks. Backtick looks like this: `
The backtick may be found in the upper left corner of the keyboard, sharing a key with the tilde (~).
Type the code between the two backticks.
This text is formatted as code.
To add a block of code, type .. code:: {coding language here}. Then copy and paste the code. Make sure indentation of each row is correct. The text in the code block will appear in different colors for readability.
from csv import DictReader
import os
import json
import shutil
Similar to a code block, you will write the line .. raw:: html". In the next line, with a single indentation, type <iframe src="{link to document or spreadsheet}" height="{height}" width="{width}" frameborder="0" allowfullscreen></iframe>.
