Task 5: Get familiar with the sphinx

[swapnilpjoshi]

• [x] Inspect the sphinx code of chapter #5 (docs/chapters/chapter-5.rst) and compare with what was generated.
• [x] Choose three sphinx commands used in the chapter
• [x] Chosen command 1
  • [x] Find the command documentation
  • [x] add a comment that contains
    • [x] link to the command documentation
    • [x] picture of the handwritten copy of the command documentation (with the reasonable size of your handwriting limit is 1 page)
• [x] Chosen command 2
  • [x] Find the command documentation
  • [x] add a comment that contains
    • [x] link to the command documentation
    • [x] picture of the handwritten copy of the command documentation (with the reasonable size of your handwriting limit is 1 page)
• [x] Chosen command 3
  • [x] Find the command documentation
  • [x] add a comment that contains
    • [x] link to the command documentation
    • [x] picture of the handwritten copy of the command documentation (with the reasonable size of your handwriting limit is 1 page)
• [x] Put the link of this issue on a comment of the issue of task 1

[swapnilpjoshi]

After inspecting the code and its output, some of the things I learned are:

• .. image:: is used when we want to add an image to the page. The name can refer to the path of the image like images/cat.png. :scale: and :align: are used to define the size and alignment of the image.

• ======= is used to define Heading 1, ------- is used to define Heading 1 and ...... is used to define Heading 1

• .. contents:: is used for adding the table of contents

3 commands chosen by me for the task are given below: [1], [2], [3]

[swapnilpjoshi]

Chosen Command 1: .. note:: Link to Documentation: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=note%3A%3A#directive-note

Picture of the handwritten documentation:

[swapnilpjoshi]

Chosen Command 2: .. code-block:: Link to Documentation: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=..%20code-block%3A%3A#directive-code-block

Picture of the handwritten documentation:

[swapnilpjoshi]

Chosen Command 3: .. literalinclude:: Link to Documentation: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude

Picture of the handwritten documentation: