Skip to content

Commit

Permalink
modified
Browse files Browse the repository at this point in the history
  • Loading branch information
sailajakommineni committed Nov 28, 2023
1 parent ae41a4c commit 1f64ac7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/checking.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This directory contains the files required to create open-source documentation.
Tools used: [Sphinx] (http://www.sphinx-doc.org/).
## Configuration files
* **index.rst** - This is the main document. The main function of this document is to serve as a welcome page and to contain the root of the “table of contents tree”. This is one of the main things that Sphinx adds to restructured text: a way to connect multiple files to a single hierarchy of documents.
* **index.rst** - This is the main document. "This is one of the main things that Sphinx adds to reStructuredText: a way to connect multiple files to a single hierarchy of documents, including the 'table of contents tree' (or toctree)."
* **conf.py**: The configuration directory must contain a file named conf.py. This file (containing Python code) is called the “build configuration file” and contains (almost) all the configuration needed to customize Sphinx input and output behavior.
* **.md files**: Create all the markdown files that are referenced in the document tree with the appropriate content.

Expand Down

0 comments on commit 1f64ac7

Please sign in to comment.