deploy: 3040ce4

psm-compute · Sep 9, 2024 · 0ab670b · 0ab670b
1 parent a9ff98c
commit 0ab670b
Show file tree

Hide file tree

Showing 12 changed files with 396 additions and 141 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d4c4c9cae46479850f4421c4eecaf5af
+config: d1a7ef06ecb70dbff6f0894cd99f80af
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/git.rst.txt b/_sources/git.rst.txt
@@ -102,68 +102,3 @@ If you no longer need the branch locally, you can delete it:
 .. code:: bash
 
     git branch -d update_readme
-
-
-Modifying the HTML Webpage
----------------------------
-
-1. Compile the HTML Webpage Locally
-____________________________________
-
-To compile the HTML files locally, navigate to the parent directory of your project and run:
-
-.. code-block:: bash
-
-    make html
-
-This command will generate the HTML files for your webpage.
-
-**Troubleshooting:**
-
-- If the ``make html`` command fails, you might need to install the necessary dependencies first. You can do this by running:
-
-  .. code-block:: bash
-
-      pip install -r requirements.txt
-
-2. View the Compiled HTML
-__________________________
-
-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.
-
-3. Modify the Documentation
-____________________________
-
-**Important:** 
-
-- **Never modify files directly in the** ``html`` **folder.**
-- Always make changes in the ``docs/source`` folder, which contains the source files used to generate the HTML.
-
-**Steps for Modifying Content:**
-
-1. **Create a New** ``.rst`` **File:**
-
-   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.
-
-   - **Formatting Tips:** For guidance on formatting ``.rst`` files, refer to `appropriate documentation <https://developer.lsst.io/restructuredtext/style.html>`_.
-
-
-2. **Update the** ``index.rst`` **File:**
-
-   After adding or modifying ``.rst`` files, update the ``index.rst`` file to include your new content in the table of contents or navigation structure.
-
-4. Re-compile the HTML Webpage
-_______________________________
-
-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:
-
-.. code-block:: bash
-
-    make html
-
-This will regenerate the HTML files with your latest modifications.
-
-5. Commit and Push Changes
-__________________________
-
-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>`_.
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -15,3 +15,9 @@ start a discussion on |GitHub_discussion|
 
    oar
    git
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contributors:
+
+   sphinx
diff --git a/_sources/sphinx.rst.txt b/_sources/sphinx.rst.txt
@@ -0,0 +1,72 @@
+Sphinx tips
+===========
+
+Contributing to this Documentation
+----------------------------------
+
+1. Compile the HTML Webpage Locally
+____________________________________
+
+To compile the HTML files locally, navigate to the parent directory of your project and run:
+
+.. code-block:: bash
+
+    make html
+
+This command will generate the HTML files for your webpage.
+
+**Troubleshooting:**
+
+- If the ``make html`` command fails, you might need to install the necessary dependencies first. You can do this by running:
+
+  .. code-block:: bash
+
+      pip install -r requirements.txt
+
+2. View the Compiled HTML
+__________________________
+
+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.
+
+3. Modify the Documentation
+____________________________
+
+**Important:** 
+
+- **Never modify files directly in the** ``html`` **folder.**
+- Always make changes in the ``docs/source`` folder, which contains the source files used to generate the HTML.
+
+**Steps for Modifying Content:**
+
+1. **Create a New** ``.rst`` **File:**
+
+   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.
+
+   - **Formatting Tips:** For guidance on formatting ``.rst`` files, refer to `appropriate documentation <https://developer.lsst.io/restructuredtext/style.html>`_.
+
+
+2. **Update the** ``index.rst`` **File:**
+
+   After adding or modifying ``.rst`` files, update the ``index.rst`` file to include your new content in the table of contents or navigation structure.
+
+4. Re-compile the HTML Webpage
+_______________________________
+
+Once you've made your changes, first delete previous files to avoid conflict:
+
+.. code-block:: bash
+
+   make clean
+
+Second recompile the HTML files by running ``make html`` again from the parent directory (``docs``), where the ``make.bat`` file is located:
+
+.. code-block:: bash
+
+    make html
+
+This will regenerate the HTML files with your latest modifications.
+
+5. Commit and Push Changes
+__________________________
+
+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>`_.
diff --git a/genindex.html b/genindex.html
@@ -25,7 +25,7 @@
                         <img src="_static/img/wagtail-logo-new.svg" width="45" height="59" alt="Wagtail"
                             class="logo-img"
                         />
-                        Sphinx Wagtail Theme
+                        PSM tips
                     </a>
 
 
@@ -57,6 +57,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="oar.html">OAR tips</a></li>
 <li class="toctree-l1"><a class="reference internal" href="git.html">GIT tips</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Contributors:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="sphinx.html">Sphinx tips</a></li>
 </ul>
 
     </nav>
@@ -89,7 +93,7 @@
                             <span class="dark-only"><i class="fas fa-sun"></i> Light mode</span>
                             <span class="light-only"><i class="fas fa-moon"></i> Dark mode</span>
                         </button>
-    <a class="btn btn-sm btn-light text-decoration-none" href="https://github.com/psm-compute/psm-compute.github.io/tree/main/docsgenindex" rel="nofollow">
+    <a class="btn btn-sm btn-light text-decoration-none" href="https://github.com/psm-compute/psm-compute.github.io/tree/main/docs/source/genindex" rel="nofollow">
         <span class="btn-icon"><span class="fab fa-github"></span></span>
         <span class="btn-text">Edit on GitHub</span>
     </a>

diff --git a/git.html b/git.html
@@ -13,6 +13,7 @@
             <link rel="index" title="Index" href="genindex.html" />
             <link rel="search" title="Search" href="search.html" />
             <link rel="top" title="PSM tips and trics page" href="#" />
+            <link rel="next" title="Sphinx tips" href="sphinx.html" />
             <link rel="prev" title="OAR tips" href="oar.html" />
     </head>
 <body>
@@ -28,7 +29,7 @@
                         <img src="_static/img/wagtail-logo-new.svg" width="45" height="59" alt="Wagtail"
                             class="logo-img"
                         />
-                        Sphinx Wagtail Theme
+                        PSM tips
                     </a>
 
 
@@ -60,6 +61,10 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="oar.html">OAR tips</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">GIT tips</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Contributors:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="sphinx.html">Sphinx tips</a></li>
 </ul>
 
     </nav>
@@ -92,7 +97,7 @@
                             <span class="dark-only"><i class="fas fa-sun"></i> Light mode</span>
                             <span class="light-only"><i class="fas fa-moon"></i> Dark mode</span>
                         </button>
-    <a class="btn btn-sm btn-light text-decoration-none" href="https://github.com/psm-compute/psm-compute.github.io/tree/main/docsgit.rst" rel="nofollow">
+    <a class="btn btn-sm btn-light text-decoration-none" href="https://github.com/psm-compute/psm-compute.github.io/tree/main/docs/source/git.rst" rel="nofollow">
         <span class="btn-icon"><span class="fab fa-github"></span></span>
         <span class="btn-text">Edit on GitHub</span>
     </a>
@@ -187,68 +192,16 @@ <h3>7. Delete the Branch Locally (Optional)<a class="headerlink" href="#delete-t
 </div>
 </section>
 </section>
-<section id="modifying-the-html-webpage">
-<h2>Modifying the HTML Webpage<a class="headerlink" href="#modifying-the-html-webpage" title="Link to this heading">¶</a></h2>
-<section id="compile-the-html-webpage-locally">
-<h3>1. Compile the HTML Webpage Locally<a class="headerlink" href="#compile-the-html-webpage-locally" title="Link to this heading">¶</a></h3>
-<p>To compile the HTML files locally, navigate to the parent directory of your project and run:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>html
-</pre></div>
-</div>
-<p>This command will generate the HTML files for your webpage.</p>
-<p><strong>Troubleshooting:</strong></p>
-<ul>
-<li><p>If the <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">html</span></code> command fails, you might need to install the necessary dependencies first. You can do this by running:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
-</pre></div>
-</div>
-</li>
-</ul>
-</section>
-<section id="view-the-compiled-html">
-<h3>2. View the Compiled HTML<a class="headerlink" href="#view-the-compiled-html" title="Link to this heading">¶</a></h3>
-<p>Once the compilation is successful, you can view the HTML files by navigating to the <code class="docutils literal notranslate"><span class="pre">docs/build/html</span></code> directory. Open the files in this folder with your preferred web browser to see your webpage.</p>
-</section>
-<section id="modify-the-documentation">
-<h3>3. Modify the Documentation<a class="headerlink" href="#modify-the-documentation" title="Link to this heading">¶</a></h3>
-<p><strong>Important:</strong></p>
-<ul class="simple">
-<li><p><strong>Never modify files directly in the</strong> <code class="docutils literal notranslate"><span class="pre">html</span></code> <strong>folder.</strong></p></li>
-<li><p>Always make changes in the <code class="docutils literal notranslate"><span class="pre">docs/source</span></code> folder, which contains the source files used to generate the HTML.</p></li>
-</ul>
-<p><strong>Steps for Modifying Content:</strong></p>
-<ol class="arabic">
-<li><p><strong>Create a New</strong> <code class="docutils literal notranslate"><span class="pre">.rst</span></code> <strong>File:</strong></p>
-<p>If you need to add new content, you can create a new <code class="docutils literal notranslate"><span class="pre">.rst</span></code> file in the <code class="docutils literal notranslate"><span class="pre">docs/source</span></code> directory. Use an existing file, such as <code class="docutils literal notranslate"><span class="pre">oar.rst</span></code>, as a template for the new file.</p>
-<ul class="simple">
-<li><p><strong>Formatting Tips:</strong> For guidance on formatting <code class="docutils literal notranslate"><span class="pre">.rst</span></code> files, refer to <a class="reference external" href="https://developer.lsst.io/restructuredtext/style.html">appropriate documentation</a>.</p></li>
-</ul>
-</li>
-<li><p><strong>Update the</strong> <code class="docutils literal notranslate"><span class="pre">index.rst</span></code> <strong>File:</strong></p>
-<p>After adding or modifying <code class="docutils literal notranslate"><span class="pre">.rst</span></code> files, update the <code class="docutils literal notranslate"><span class="pre">index.rst</span></code> file to include your new content in the table of contents or navigation structure.</p>
-</li>
-</ol>
-</section>
-<section id="re-compile-the-html-webpage">
-<h3>4. Re-compile the HTML Webpage<a class="headerlink" href="#re-compile-the-html-webpage" title="Link to this heading">¶</a></h3>
-<p>Once you’ve made your changes, recompile the HTML files by running <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">html</span></code> again from the parent directory (<code class="docutils literal notranslate"><span class="pre">docs</span></code>), where the <code class="docutils literal notranslate"><span class="pre">make.bat</span></code> file is located:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>html
-</pre></div>
-</div>
-<p>This will regenerate the HTML files with your latest modifications.</p>
-</section>
-<section id="id1">
-<h3>5. Commit and Push Changes<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3>
-<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 <a class="reference external" href="#getting-started-with-git-and-github">Getting Started with Git and GitHub</a>.</p>
-</section>
-</section>
 </section>
 
 </main>
                         <nav aria-label="Page navigation" class="py-4 my-5 clearfix font-weight-bold border-top">
     <a class="float-left" href="oar.html" title="Previous">
         <span aria-hidden="true">←&nbsp;</span>OAR tips
     </a>
+    <a class="float-right" href="sphinx.html" title="Next">
+        Sphinx tips <span aria-hidden="true">&nbsp;→</span>
+    </a>
 </nav>
                     </div>
 
@@ -268,14 +221,6 @@ <h3>5. Commit and Push Changes<a class="headerlink" href="#id1" title="Link to t
 <li><a class="reference internal" href="#delete-the-branch-locally-optional">7. Delete the Branch Locally (Optional)</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#modifying-the-html-webpage">Modifying the HTML Webpage</a><ul>
-<li><a class="reference internal" href="#compile-the-html-webpage-locally">1. Compile the HTML Webpage Locally</a></li>
-<li><a class="reference internal" href="#view-the-compiled-html">2. View the Compiled HTML</a></li>
-<li><a class="reference internal" href="#modify-the-documentation">3. Modify the Documentation</a></li>
-<li><a class="reference internal" href="#re-compile-the-html-webpage">4. Re-compile the HTML Webpage</a></li>
-<li><a class="reference internal" href="#id1">5. Commit and Push Changes</a></li>
-</ul>
-</li>
 </ul>
 </li>
 </ul>

diff --git a/index.html b/index.html
@@ -28,7 +28,7 @@
                         <img src="_static/img/wagtail-logo-new.svg" width="45" height="59" alt="Wagtail"
                             class="logo-img"
                         />
-                        Sphinx Wagtail Theme
+                        PSM tips
                     </a>
 
 
@@ -60,6 +60,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="oar.html">OAR tips</a></li>
 <li class="toctree-l1"><a class="reference internal" href="git.html">GIT tips</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Contributors:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="sphinx.html">Sphinx tips</a></li>
 </ul>
 
     </nav>
@@ -92,7 +96,7 @@
                             <span class="dark-only"><i class="fas fa-sun"></i> Light mode</span>
                             <span class="light-only"><i class="fas fa-moon"></i> Dark mode</span>
                         </button>
-    <a class="btn btn-sm btn-light text-decoration-none" href="https://github.com/psm-compute/psm-compute.github.io/tree/main/docsindex.rst" rel="nofollow">
+    <a class="btn btn-sm btn-light text-decoration-none" href="https://github.com/psm-compute/psm-compute.github.io/tree/main/docs/source/index.rst" rel="nofollow">
         <span class="btn-icon"><span class="fab fa-github"></span></span>
         <span class="btn-text">Edit on GitHub</span>
     </a>
@@ -126,7 +130,15 @@ <h1>Unofficial PSM tips and tricks<a class="headerlink" href="#unofficial-psm-ti
 </li>
 <li class="toctree-l1"><a class="reference internal" href="git.html">GIT tips</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="git.html#getting-started-with-git-and-github">Getting Started with Git and GitHub</a></li>
-<li class="toctree-l2"><a class="reference internal" href="git.html#modifying-the-html-webpage">Modifying the HTML Webpage</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound">
+<p class="caption" role="heading"><span class="caption-text">Contributors:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="sphinx.html">Sphinx tips</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="sphinx.html#contributing-to-this-documentation">Contributing to this Documentation</a></li>
 </ul>
 </li>
 </ul>

diff --git a/oar.html b/oar.html
@@ -29,7 +29,7 @@
                         <img src="_static/img/wagtail-logo-new.svg" width="45" height="59" alt="Wagtail"
                             class="logo-img"
                         />
-                        Sphinx Wagtail Theme
+                        PSM tips
                     </a>
 
 
@@ -61,6 +61,10 @@
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">OAR tips</a></li>
 <li class="toctree-l1"><a class="reference internal" href="git.html">GIT tips</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Contributors:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="sphinx.html">Sphinx tips</a></li>
 </ul>
 
     </nav>
@@ -93,7 +97,7 @@
                             <span class="dark-only"><i class="fas fa-sun"></i> Light mode</span>
                             <span class="light-only"><i class="fas fa-moon"></i> Dark mode</span>
                         </button>
-    <a class="btn btn-sm btn-light text-decoration-none" href="https://github.com/psm-compute/psm-compute.github.io/tree/main/docsoar.rst" rel="nofollow">
+    <a class="btn btn-sm btn-light text-decoration-none" href="https://github.com/psm-compute/psm-compute.github.io/tree/main/docs/source/oar.rst" rel="nofollow">
         <span class="btn-icon"><span class="fab fa-github"></span></span>
         <span class="btn-text">Edit on GitHub</span>
     </a>

diff --git a/objects.inv b/objects.inv
@@ -2,4 +2,6 @@
 # Project: tips-and-tricks
 # Version: 
 # The remainder of this file is compressed using zlib.
-xڅ�1�0E���(+�PQ8@H��"M��H��@D+!����gc��켺Z�\�nz<��Q8���3���>��7� ��K�]���6�Є���͏�\}Ni��{[�D5-��V����Y���ʙ���ɪI�k#��Ӳ.���	3�qC
+xڅ�A� D���_�&nݹ2]46V�@�G
+M�&��*c�����7�`M���靗W�ڂ-����~�Eʐ�*#H��3�I|{
+�������Pzh�&� ��Pݒ���b����-M�woʞ(��c�+C����,�zۙ\��d��:�g:�[i�H�ð�:+�d7oz�W