Deploying to gh-pages from @ ce0d8c9 🚀

DCC-EX · Dec 7, 2023 · 52d3e05 · 52d3e05
1 parent 2d4447d
commit 52d3e05
Show file tree

Hide file tree

Showing 17 changed files with 618 additions and 17 deletions.
diff --git a/_sources/bugs-requests.rst.txt b/_sources/bugs-requests.rst.txt
@@ -0,0 +1,4 @@
+Bugs and Requests
+=================
+
+To report any bugs or raise support/feature requests for the library, please use our handy GitHub issue templates provided in the `DCCEXProtocol GitHub repository <https://github.com/DCC-EX/DCCEXProtocol/issues/new/choose>`_.
diff --git a/_sources/documentation.rst.txt → _sources/contribute.rst.txt b/_sources/documentation.rst.txt → _sources/contribute.rst.txt
@@ -1,9 +1,17 @@
 .. include:: /include/include.rst
-:orphan:
 
-Documentation
+Contributions
 =============
 
+The |DCC-EX| team welcomes contributions to the DCCEXProtocol library.
+
+The best way to get involved is to reach out to the |DCC-EX| team via our `Discord server <https://discord.gg/PuPnNMp8Qf>`_.
+
+You can also try the other methods outlined on our `Contact Us page <https://dcc-ex.com/support/contact-us.html>`_.
+
+Documentation
+-------------
+
 This documentation is available via the `DCC-EX website <https://dcc-ex.com/DCCEXProtocol/index.html>`_.
 
 For contributors wishing to build local copies of the documentation while updating the library, here is the very high level process of the requirements to make this work on Windows:

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -12,6 +12,8 @@ Documentation for the DCC-EX Native command library - DCCEXProtocol
   usage
   examples
   library
+  bugs-requests
+  contribute
   site-index
 
 DCC-EX Native command protocol library

diff --git a/bugs-requests.html b/bugs-requests.html
diff --git a/documentation.html → contribute.html b/documentation.html → contribute.html
@@ -5,7 +5,7 @@
 <meta content="DCC-EX DCC DCC++ EX DCC++EX" name="keywords" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Documentation &mdash; DCCEXProtocol  documentation</title>
+  <title>Contributions &mdash; DCCEXProtocol  documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/css/dccex_theme.css?v=2e0e464c" />
@@ -15,7 +15,7 @@
 
 
     <link rel="shortcut icon" href="_static/favicon.ico"/>
-    <link rel="canonical" href="https://dcc-ex.com/DCCEXProtocol/documentation.html" />
+    <link rel="canonical" href="https://dcc-ex.com/DCCEXProtocol/contribute.html" />
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -29,7 +29,9 @@
         <script src="_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" /> 
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Indices and tables" href="site-index.html" />
+    <link rel="prev" title="Bugs and Requests" href="bugs-requests.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -52,7 +54,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <ul>
+              <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
 <li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
@@ -454,6 +456,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="site-index.html">Indices and tables</a></li>
 </ul>
 
@@ -471,18 +478,23 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
-      <li class="breadcrumb-item active">Documentation</li>
+      <li class="breadcrumb-item active">Contributions</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/DCC-EX/dccexprotocol/blob/sphinx/docs/documentation.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/DCC-EX/dccexprotocol/blob/sphinx/docs/contribute.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="documentation">
-<h1>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></a></h1>
+  <section id="contributions">
+<h1>Contributions<a class="headerlink" href="#contributions" title="Link to this heading"></a></h1>
+<p>The <span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span> team welcomes contributions to the DCCEXProtocol library.</p>
+<p>The best way to get involved is to reach out to the <span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span> team via our <a class="reference external" href="https://discord.gg/PuPnNMp8Qf">Discord server</a>.</p>
+<p>You can also try the other methods outlined on our <a class="reference external" href="https://dcc-ex.com/support/contact-us.html">Contact Us page</a>.</p>
+<section id="documentation">
+<h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></a></h2>
 <p>This documentation is available via the <a class="reference external" href="https://dcc-ex.com/DCCEXProtocol/index.html">DCC-EX website</a>.</p>
 <p>For contributors wishing to build local copies of the documentation while updating the library, here is the very high level process of the requirements to make this work on Windows:</p>
 <ul class="simple">
@@ -499,12 +511,16 @@ <h1>Documentation<a class="headerlink" href="#documentation" title="Link to this
 <li><p>Oliver K Ernst on <a class="reference external" href="https://medium.com/practical-coding/c-documentation-with-doxygen-cmake-sphinx-breathe-for-those-of-use-who-are-totally-lost-7d555386fe13">Medium</a></p></li>
 <li><p>Sy Brand in her <a class="reference external" href="https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/">Microsoft Blog</a></p></li>
 </ul>
+</section>
 </section>
 
 
            </div>
           </div>
-          <footer>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="bugs-requests.html" class="btn btn-neutral float-left" title="Bugs and Requests" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="site-index.html" class="btn btn-neutral float-right" title="Indices and tables" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
 
   <hr/>
 

diff --git a/examples.html b/examples.html
@@ -456,6 +456,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="site-index.html">Indices and tables</a></li>
 </ul>
 

diff --git a/genindex.html b/genindex.html
@@ -452,6 +452,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="site-index.html">Indices and tables</a></li>
 </ul>
 

diff --git a/include/include.html b/include/include.html
@@ -454,6 +454,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute.html">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute.html#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="../site-index.html">Indices and tables</a></li>
 </ul>
 

diff --git a/index.html b/index.html
@@ -455,6 +455,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="site-index.html">Indices and tables</a></li>
 </ul>
 

diff --git a/library.html b/library.html
@@ -29,7 +29,7 @@
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Indices and tables" href="site-index.html" />
+    <link rel="next" title="Bugs and Requests" href="bugs-requests.html" />
     <link rel="prev" title="Examples" href="examples.html" /> 
 </head>
 
@@ -455,6 +455,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="site-index.html">Indices and tables</a></li>
 </ul>
 
@@ -3464,7 +3469,7 @@ <h1>Library<a class="headerlink" href="#library" title="Link to this heading">
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="examples.html" class="btn btn-neutral float-left" title="Examples" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="site-index.html" class="btn btn-neutral float-right" title="Indices and tables" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="bugs-requests.html" class="btn btn-neutral float-right" title="Bugs and Requests" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/objects.inv b/objects.inv
diff --git a/overview.html b/overview.html
@@ -456,6 +456,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="site-index.html">Indices and tables</a></li>
 </ul>
 

diff --git a/search.html b/search.html
@@ -455,6 +455,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="site-index.html">Indices and tables</a></li>
 </ul>
 

diff --git a/searchindex.js b/searchindex.js
diff --git a/site-index.html b/site-index.html
@@ -30,7 +30,7 @@
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="Library" href="library.html" /> 
+    <link rel="prev" title="Contributions" href="contribute.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -455,6 +455,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Indices and tables</a></li>
 </ul>
 
@@ -493,7 +498,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Li
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="library.html" class="btn btn-neutral float-left" title="Library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="contribute.html" class="btn btn-neutral float-left" title="Contributions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 
   <hr/>

diff --git a/sitemap.xml b/sitemap.xml
@@ -1,2 +1,2 @@
 <?xml version='1.0' encoding='utf-8'?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url><loc>https://dcc-ex.com/DCCEXProtocol/en/documentation.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/examples.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/include/include.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/index.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/library.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/overview.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/site-index.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/usage.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/genindex.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/search.html</loc></url></urlset>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url><loc>https://dcc-ex.com/DCCEXProtocol/en/bugs-requests.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/contribute.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/examples.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/include/include.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/index.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/library.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/overview.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/site-index.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/usage.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/genindex.html</loc></url><url><loc>https://dcc-ex.com/DCCEXProtocol/en/search.html</loc></url></urlset>
diff --git a/usage.html b/usage.html
@@ -456,6 +456,11 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="bugs-requests.html">Bugs and Requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#documentation">Documentation</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="site-index.html">Indices and tables</a></li>
 </ul>