Skip to content

Commit 5801ec7

Browse files
committed
small modifications
1 parent b3776b2 commit 5801ec7

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

docs/source/sphinx.rst

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Contributing to this Documentation
77
1. Compile the HTML Webpage Locally
88
____________________________________
99

10-
To compile the HTML files locally, navigate to the parent directory of your project and run:
10+
To compile the HTML files locally, navigate to the docs/ folder and type:
1111

1212
.. code-block:: bash
1313
@@ -17,24 +17,28 @@ This command will generate the HTML files for your webpage.
1717

1818
**Troubleshooting:**
1919

20-
- If the ``make html`` command fails, you might need to install the necessary dependencies first. You can do this by running:
20+
If the ``make html`` command fails, you might need to install the necessary
21+
dependencies first. You can do this by running:
2122

22-
.. code-block:: bash
23+
.. code-block:: bash
2324
24-
pip install -r requirements.txt
25+
pip install -r requirements.txt
2526
2627
2. View the Compiled HTML
2728
__________________________
2829

29-
Once the compilation is successful, you can view the HTML files by navigating to the ``docs/build/html`` directory. Open the files in this folder with your preferred web browser to see your webpage.
30+
Once the compilation is successful, you can view the HTML files by navigating
31+
to the ``docs/build/html`` directory. Open the files in this folder with your
32+
preferred web browser to see the webpage.
3033

3134
3. Modify the Documentation
3235
____________________________
3336

3437
**Important:**
3538

3639
- **Never modify files directly in the** ``html`` **folder.**
37-
- Always make changes in the ``docs/source`` folder, which contains the source files used to generate the HTML.
40+
- Always make changes in the ``docs/source`` folder, which contains the source
41+
files used to generate the HTML.
3842

3943
**Steps for Modifying Content:**
4044

@@ -58,7 +62,8 @@ Once you've made your changes, first delete previous files to avoid conflict:
5862
5963
make clean
6064
61-
Second recompile the HTML files by running ``make html`` again from the parent directory (``docs``), where the ``make.bat`` file is located:
65+
Second, recompile the HTML files by running ``make html`` again from the parent
66+
directory (``docs/``), where the ``make.bat`` file is located:
6267

6368
.. code-block:: bash
6469
@@ -69,4 +74,6 @@ This will regenerate the HTML files with your latest modifications.
6974
5. Commit and Push Changes
7075
__________________________
7176

72-
After confirming your changes are reflected in the compiled HTML, it's time to commit and push your changes to the repository. For detailed instructions on how to commit and push changes, see :ref:`git-tips`.
77+
After confirming your changes are reflected in the compiled HTML, it's time to
78+
commit and push your changes to the repository. For detailed instructions on
79+
how to commit and push changes, see :ref:`git-tips`.

0 commit comments

Comments
 (0)