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 50e3939 commit ae41a4c
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions .github/checking.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
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 re structured text: a way to connect multiple files to a single hierarchy of documents.
* **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.
* **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.

```
./
├── docs
│   ├── source
│   │     ├── index.rst
│   │     ├── conf.py
│   │     ├── *.md
│   │   ├── index.rst
│   │   ├── conf.py
│   │   ├── *.md
│   ├── Makefile
|   ├── pip-requirements.txt
│   └── README.md
Expand All @@ -25,7 +25,7 @@ Tools used: [Sphinx] (http://www.sphinx-doc.org/).
```
pip install -U Sphinx
```
2. Install the pre-requisites.
2. Install the prerequisites.
```
pip install -r pip-requirements.txt
```
Expand All @@ -35,6 +35,4 @@ make HTML
or
make.bat HTML
```
4. Access the documents from the **build/html** folder.

The team are playing well.
4. Access the documents from the **build/html** folder.

0 comments on commit ae41a4c

Please sign in to comment.