Skip to content

Commit b7bb8b2

Browse files
committed
rst fixes
1 parent d104307 commit b7bb8b2

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

electrical/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Overview of Mechanical Documentation
1+
# Overview of Electrical Documentation
22
This document provides a high level overview of how to complete documentation for the mechanical team. See the below sections for more information about how to update the Resources, Design Specs, CAD, Presentations, and System Design Review pages.
33

44
## Resources

rst/how-to-use-rst.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Section 2
4343
Images
4444
------
4545

46-
.. image:: path/to/image.png
46+
.. image:: rst/scratch_cat.png
4747
:alt: Alternative text
4848
:width: 200px
4949
:align: center
@@ -53,16 +53,16 @@ Videos
5353

5454
.. raw:: html
5555

56-
<iframe width="560" height="315" src="https://www.youtube.com/embed/VIDEO_ID" frameborder="0" allowfullscreen></iframe>
56+
<iframe width="560" height="315" src="https://www.youtube.com/watch?v=DSIuLnoKLd8" frameborder="0" allowfullscreen></iframe>
5757

5858
Links
5959
-----
6060

61-
Inline Link: `Link text <http://example.com>`_
61+
Inline Link: `RST Tutorial <https://sphinx-tutorial.readthedocs.io/step-1/>`_
6262

6363
Footnote Link: Link text [#]_.
6464

65-
.. [#] http://example.com
65+
.. [#] https://sphinx-tutorial.readthedocs.io/start/
6666
6767
Tables
6868
------
@@ -128,10 +128,10 @@ Summary Table
128128
| **Italic** | ``*Italic*`` | Creates italic text |
129129
| **Bold** | ``**Bold**`` | Creates bold text |
130130
| **List** | ``- Item 1\n- Item 2`` | Creates an unordered list |
131-
| **Image** | ``.. image:: path/to/image.png\n :alt: Alt text`` | Embeds an image |
132-
| **Video** | ``.. raw:: html\n <iframe src="URL"></iframe>`` | Embeds a video |
131+
| **Image** | ``.. image:: path/to/image.png\n :alt: Alt text`` | Embeds an image |
132+
| **Video** | ``.. raw:: html\n <iframe src="URL"></iframe>`` | Embeds a video |
133133
| **Link** | `` `Link text <http://example.com>`_ `` | Creates a hyperlink |
134134
| **Table** | ``+---+---+\n| H1 | H2 |\n+===+===+\n| C1 | C2 |\n+---+---+`` | Creates a simple table |
135-
| **Code** | ``::\n def func():\n print("code")`` | Creates a code block |
136-
| **Directive**| ``.. note::\n This is a note.`` | Adds special content like notes or warnings |
135+
| **Code** | ``::\n def func():\n print("code")`` | Creates a code block |
136+
| **Directive**| ``.. note::\n This is a note.`` | Adds special content like notes or warnings |
137137
+--------------+------------------------------------------------------------+----------------------------------------------+

rst/scratch_cat.png

7.35 KB
Loading

0 commit comments

Comments
 (0)