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: _sources/git.rst.txt
-65Lines changed: 0 additions & 65 deletions
Original file line number
Diff line number
Diff line change
@@ -102,68 +102,3 @@ If you no longer need the branch locally, you can delete it:
102
102
.. code:: bash
103
103
104
104
git branch -d update_readme
105
-
106
-
107
-
Modifying the HTML Webpage
108
-
---------------------------
109
-
110
-
1. Compile the HTML Webpage Locally
111
-
____________________________________
112
-
113
-
To compile the HTML files locally, navigate to the parent directory of your project and run:
114
-
115
-
.. code-block:: bash
116
-
117
-
make html
118
-
119
-
This command will generate the HTML files for your webpage.
120
-
121
-
**Troubleshooting:**
122
-
123
-
- If the ``make html`` command fails, you might need to install the necessary dependencies first. You can do this by running:
124
-
125
-
.. code-block:: bash
126
-
127
-
pip install -r requirements.txt
128
-
129
-
2. View the Compiled HTML
130
-
__________________________
131
-
132
-
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.
133
-
134
-
3. Modify the Documentation
135
-
____________________________
136
-
137
-
**Important:**
138
-
139
-
- **Never modify files directly in the** ``html`` **folder.**
140
-
- Always make changes in the ``docs/source`` folder, which contains the source files used to generate the HTML.
141
-
142
-
**Steps for Modifying Content:**
143
-
144
-
1. **Create a New** ``.rst`` **File:**
145
-
146
-
If you need to add new content, you can create a new ``.rst`` file in the ``docs/source`` directory. Use an existing file, such as ``oar.rst``, as a template for the new file.
147
-
148
-
- **Formatting Tips:** For guidance on formatting ``.rst`` files, refer to `appropriate documentation <https://developer.lsst.io/restructuredtext/style.html>`_.
149
-
150
-
151
-
2. **Update the** ``index.rst`` **File:**
152
-
153
-
After adding or modifying ``.rst`` files, update the ``index.rst`` file to include your new content in the table of contents or navigation structure.
154
-
155
-
4. Re-compile the HTML Webpage
156
-
_______________________________
157
-
158
-
Once you've made your changes, recompile the HTML files by running ``make html`` again from the parent directory (``docs``), where the ``make.bat`` file is located:
159
-
160
-
.. code-block:: bash
161
-
162
-
make html
163
-
164
-
This will regenerate the HTML files with your latest modifications.
165
-
166
-
5. Commit and Push Changes
167
-
__________________________
168
-
169
-
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 see `Getting Started with Git and GitHub <#getting-started-with-git-and-github>`_.
To compile the HTML files locally, navigate to the parent directory of your project and run:
11
+
12
+
.. code-block:: bash
13
+
14
+
make html
15
+
16
+
This command will generate the HTML files for your webpage.
17
+
18
+
**Troubleshooting:**
19
+
20
+
- If the ``make html`` command fails, you might need to install the necessary dependencies first. You can do this by running:
21
+
22
+
.. code-block:: bash
23
+
24
+
pip install -r requirements.txt
25
+
26
+
2. View the Compiled HTML
27
+
__________________________
28
+
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
+
31
+
3. Modify the Documentation
32
+
____________________________
33
+
34
+
**Important:**
35
+
36
+
- **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.
38
+
39
+
**Steps for Modifying Content:**
40
+
41
+
1. **Create a New** ``.rst`` **File:**
42
+
43
+
If you need to add new content, you can create a new ``.rst`` file in the ``docs/source`` directory. Use an existing file, such as ``oar.rst``, as a template for the new file.
44
+
45
+
- **Formatting Tips:** For guidance on formatting ``.rst`` files, refer to `appropriate documentation <https://developer.lsst.io/restructuredtext/style.html>`_.
46
+
47
+
48
+
2. **Update the** ``index.rst`` **File:**
49
+
50
+
After adding or modifying ``.rst`` files, update the ``index.rst`` file to include your new content in the table of contents or navigation structure.
51
+
52
+
4. Re-compile the HTML Webpage
53
+
_______________________________
54
+
55
+
Once you've made your changes, first delete previous files to avoid conflict:
56
+
57
+
.. code-block:: bash
58
+
59
+
make clean
60
+
61
+
Second recompile the HTML files by running ``make html`` again from the parent directory (``docs``), where the ``make.bat`` file is located:
62
+
63
+
.. code-block:: bash
64
+
65
+
make html
66
+
67
+
This will regenerate the HTML files with your latest modifications.
68
+
69
+
5. Commit and Push Changes
70
+
__________________________
71
+
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 `Getting Started with Git and GitHub <#git-tips>`_.
<p>This command will generate the HTML files for your webpage.</p>
199
-
<p><strong>Troubleshooting:</strong></p>
200
-
<ul>
201
-
<li><p>If the <codeclass="docutils literal notranslate"><spanclass="pre">make</span><spanclass="pre">html</span></code> command fails, you might need to install the necessary dependencies first. You can do this by running:</p>
<h3>2. View the Compiled HTML<aclass="headerlink" href="#view-the-compiled-html" title="Link to this heading">¶</a></h3>
210
-
<p>Once the compilation is successful, you can view the HTML files by navigating to the <codeclass="docutils literal notranslate"><spanclass="pre">docs/build/html</span></code> directory. Open the files in this folder with your preferred web browser to see your webpage.</p>
211
-
</section>
212
-
<sectionid="modify-the-documentation">
213
-
<h3>3. Modify the Documentation<aclass="headerlink" href="#modify-the-documentation" title="Link to this heading">¶</a></h3>
214
-
<p><strong>Important:</strong></p>
215
-
<ulclass="simple">
216
-
<li><p><strong>Never modify files directly in the</strong><codeclass="docutils literal notranslate"><spanclass="pre">html</span></code><strong>folder.</strong></p></li>
217
-
<li><p>Always make changes in the <codeclass="docutils literal notranslate"><spanclass="pre">docs/source</span></code> folder, which contains the source files used to generate the HTML.</p></li>
218
-
</ul>
219
-
<p><strong>Steps for Modifying Content:</strong></p>
220
-
<olclass="arabic">
221
-
<li><p><strong>Create a New</strong><codeclass="docutils literal notranslate"><spanclass="pre">.rst</span></code><strong>File:</strong></p>
222
-
<p>If you need to add new content, you can create a new <codeclass="docutils literal notranslate"><spanclass="pre">.rst</span></code> file in the <codeclass="docutils literal notranslate"><spanclass="pre">docs/source</span></code> directory. Use an existing file, such as <codeclass="docutils literal notranslate"><spanclass="pre">oar.rst</span></code>, as a template for the new file.</p>
223
-
<ulclass="simple">
224
-
<li><p><strong>Formatting Tips:</strong> For guidance on formatting <codeclass="docutils literal notranslate"><spanclass="pre">.rst</span></code> files, refer to <aclass="reference external" href="https://developer.lsst.io/restructuredtext/style.html">appropriate documentation</a>.</p></li>
<p>After adding or modifying <codeclass="docutils literal notranslate"><spanclass="pre">.rst</span></code> files, update the <codeclass="docutils literal notranslate"><spanclass="pre">index.rst</span></code> file to include your new content in the table of contents or navigation structure.</p>
229
-
</li>
230
-
</ol>
231
-
</section>
232
-
<sectionid="re-compile-the-html-webpage">
233
-
<h3>4. Re-compile the HTML Webpage<aclass="headerlink" href="#re-compile-the-html-webpage" title="Link to this heading">¶</a></h3>
234
-
<p>Once you’ve made your changes, recompile the HTML files by running <codeclass="docutils literal notranslate"><spanclass="pre">make</span><spanclass="pre">html</span></code> again from the parent directory (<codeclass="docutils literal notranslate"><spanclass="pre">docs</span></code>), where the <codeclass="docutils literal notranslate"><spanclass="pre">make.bat</span></code> file is located:</p>
<p>This will regenerate the HTML files with your latest modifications.</p>
239
-
</section>
240
-
<sectionid="id1">
241
-
<h3>5. Commit and Push Changes<aclass="headerlink" href="#id1" title="Link to this heading">¶</a></h3>
242
-
<p>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 see <aclass="reference external" href="#getting-started-with-git-and-github">Getting Started with Git and GitHub</a>.</p>
0 commit comments