You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/sphinx.rst
+15-8Lines changed: 15 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Contributing to this Documentation
7
7
1. Compile the HTML Webpage Locally
8
8
____________________________________
9
9
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:
11
11
12
12
.. code-block:: bash
13
13
@@ -17,24 +17,28 @@ This command will generate the HTML files for your webpage.
17
17
18
18
**Troubleshooting:**
19
19
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:
21
22
22
-
.. code-block:: bash
23
+
.. code-block:: bash
23
24
24
-
pip install -r requirements.txt
25
+
pip install -r requirements.txt
25
26
26
27
2. View the Compiled HTML
27
28
__________________________
28
29
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.
30
33
31
34
3. Modify the Documentation
32
35
____________________________
33
36
34
37
**Important:**
35
38
36
39
- **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.
38
42
39
43
**Steps for Modifying Content:**
40
44
@@ -58,7 +62,8 @@ Once you've made your changes, first delete previous files to avoid conflict:
58
62
59
63
make clean
60
64
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:
62
67
63
68
.. code-block:: bash
64
69
@@ -69,4 +74,6 @@ This will regenerate the HTML files with your latest modifications.
69
74
5. Commit and Push Changes
70
75
__________________________
71
76
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