Deploying to gh-pages from @ 102b2d5 🚀

CompNet · Mar 12, 2024 · 18802db · 18802db
1 parent 5f80123
commit 18802db
Show file tree

Hide file tree

Showing 15 changed files with 205 additions and 2 deletions.
diff --git a/_sources/contributing.rst.txt b/_sources/contributing.rst.txt
@@ -0,0 +1,39 @@
+============
+Contributing
+============
+
+Contributions to Renard are welcome! You are encouraged to open an
+issue if you encounter a problem or want to discuss a specific
+feature. If you want to contribute a patch:
+
+1. Check that your code matches our code quality guidelines and that
+   all existing tests are passing with ``RENARD_TEST_ALL=1``.
+2. Create a Github pull request with your patch, explaining the
+   rationale behind it and giving a high level overview of your
+   code. Mention the relevant issue if applicable.
+3. We will discuss the contribution further and, hopefully, merge your
+   contribution once the core maintainers are satisified.
+
+
+Code Quality Guidelines
+-----------------------
+
+The source code of Renard is entirely typed. If possible, all
+functions should be annotated with type information for arguments and
+return types.
+
+You should write docstrings for non-trivial functions and classes,
+using the Spinx docstring format. Do not forget to add your
+function/class/module to the ``docs/reference.rst`` file for it to
+show up in the online documentation. If necessary, you can add new
+documents to the documentation or complete existing ones.
+
+Format all of your code using ``black``, so that the style stay
+consistent in the repository. 
+
+When relevant, it's better to write tests for your code. Tests live in
+the ``tests`` directory. We use ``pytest`` to test code, and also use
+``hypothesis`` when applicable. If you open a patch, make sure that
+all tests are passing. In particular, do not rely on the CI, as it
+does not run time costly tests! Check for yourself locally, using
+``RENARD_TEST_ALL=1 python -m pytest tests``
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -10,6 +10,7 @@ Welcome to Renard's documentation!
    pipeline
    extending
    reference
+   contributing
 
 
 Indices and tables

diff --git a/_sources/introduction.rst.txt b/_sources/introduction.rst.txt
@@ -17,5 +17,8 @@ characters. These networks have several possible applications:
 See LabatutAndBost2019_ for a more complete overview of character
 networks and their automated extraction.
 
+.. image:: pp.svg
+
 
 .. _LabatutAndBost2019: https://arxiv.org/abs/1907.02704
+
diff --git a/contributing.html b/contributing.html
@@ -0,0 +1,145 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Contributing &mdash; Renard  documentation</title>
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/doctools.js"></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="prev" title="Reference" href="reference.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="index.html" class="icon icon-home">
+            Renard
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="pipeline.html">The Pipeline</a></li>
+<li class="toctree-l1"><a class="reference internal" href="extending.html">Extending Renard</a></li>
+<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#code-quality-guidelines">Code Quality Guidelines</a></li>
+</ul>
+</li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">Renard</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <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">Contributing</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/contributing.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="contributing">
+<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline"></a></h1>
+<p>Contributions to Renard are welcome! You are encouraged to open an
+issue if you encounter a problem or want to discuss a specific
+feature. If you want to contribute a patch:</p>
+<ol class="arabic simple">
+<li><p>Check that your code matches our code quality guidelines and that
+all existing tests are passing with <code class="docutils literal notranslate"><span class="pre">RENARD_TEST_ALL=1</span></code>.</p></li>
+<li><p>Create a Github pull request with your patch, explaining the
+rationale behind it and giving a high level overview of your
+code. Mention the relevant issue if applicable.</p></li>
+<li><p>We will discuss the contribution further and, hopefully, merge your
+contribution once the core maintainers are satisified.</p></li>
+</ol>
+<section id="code-quality-guidelines">
+<h2>Code Quality Guidelines<a class="headerlink" href="#code-quality-guidelines" title="Permalink to this headline"></a></h2>
+<p>The source code of Renard is entirely typed. If possible, all
+functions should be annotated with type information for arguments and
+return types.</p>
+<p>You should write docstrings for non-trivial functions and classes,
+using the Spinx docstring format. Do not forget to add your
+function/class/module to the <code class="docutils literal notranslate"><span class="pre">docs/reference.rst</span></code> file for it to
+show up in the online documentation. If necessary, you can add new
+documents to the documentation or complete existing ones.</p>
+<p>Format all of your code using <code class="docutils literal notranslate"><span class="pre">black</span></code>, so that the style stay
+consistent in the repository.</p>
+<p>When relevant, it’s better to write tests for your code. Tests live in
+the <code class="docutils literal notranslate"><span class="pre">tests</span></code> directory. We use <code class="docutils literal notranslate"><span class="pre">pytest</span></code> to test code, and also use
+<code class="docutils literal notranslate"><span class="pre">hypothesis</span></code> when applicable. If you open a patch, make sure that
+all tests are passing. In particular, do not rely on the CI, as it
+does not run time costly tests! Check for yourself locally, using
+<code class="docutils literal notranslate"><span class="pre">RENARD_TEST_ALL=1</span> <span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pytest</span> <span class="pre">tests</span></code></p>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="reference.html" class="btn btn-neutral float-left" title="Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2021, Arthur Amalvy, Vincent Labatut, Richard Dufour.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/extending.html b/extending.html
@@ -51,6 +51,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
         </div>

diff --git a/genindex.html b/genindex.html
@@ -45,6 +45,7 @@
 <li class="toctree-l1"><a class="reference internal" href="pipeline.html">The Pipeline</a></li>
 <li class="toctree-l1"><a class="reference internal" href="extending.html">Extending Renard</a></li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
         </div>

diff --git a/index.html b/index.html
@@ -47,6 +47,7 @@
 <li class="toctree-l1"><a class="reference internal" href="pipeline.html">The Pipeline</a></li>
 <li class="toctree-l1"><a class="reference internal" href="extending.html">Extending Renard</a></li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
         </div>
@@ -111,6 +112,10 @@ <h1>Welcome to Renard’s documentation!<a class="headerlink" href="#welcome-to-
 <li class="toctree-l2"><a class="reference internal" href="reference.html#module-renard.utils">Utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contributing.html#code-quality-guidelines">Code Quality Guidelines</a></li>
+</ul>
+</li>
 </ul>
 </div>
 </section>

diff --git a/installation.html b/installation.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="pipeline.html">The Pipeline</a></li>
 <li class="toctree-l1"><a class="reference internal" href="extending.html">Extending Renard</a></li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
         </div>

diff --git a/introduction.html b/introduction.html
@@ -48,6 +48,7 @@
 <li class="toctree-l1"><a class="reference internal" href="pipeline.html">The Pipeline</a></li>
 <li class="toctree-l1"><a class="reference internal" href="extending.html">Extending Renard</a></li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
         </div>
@@ -90,7 +91,7 @@ <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to t
 </ul>
 <p>See <a class="reference external" href="https://arxiv.org/abs/1907.02704">LabatutAndBost2019</a> for a more complete overview of character
 networks and their automated extraction.</p>
-</section>
+<img alt="pp.svg" src="pp.svg" /></section>
 
 
            </div>

diff --git a/objects.inv b/objects.inv
diff --git a/pipeline.html b/pipeline.html
@@ -65,6 +65,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="extending.html">Extending Renard</a></li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
         </div>

diff --git a/py-modindex.html b/py-modindex.html
@@ -48,6 +48,7 @@
 <li class="toctree-l1"><a class="reference internal" href="pipeline.html">The Pipeline</a></li>
 <li class="toctree-l1"><a class="reference internal" href="extending.html">Extending Renard</a></li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
         </div>

diff --git a/reference.html b/reference.html
@@ -18,6 +18,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="Contributing" href="contributing.html" />
     <link rel="prev" title="Extending Renard" href="extending.html" /> 
 </head>
 
@@ -99,6 +100,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
         </div>
@@ -2745,6 +2747,7 @@ <h3>Hypocorism<a class="headerlink" href="#hypocorism" title="Permalink to this
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="extending.html" class="btn btn-neutral float-left" title="Extending Renard" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/search.html b/search.html
@@ -48,6 +48,7 @@
 <li class="toctree-l1"><a class="reference internal" href="pipeline.html">The Pipeline</a></li>
 <li class="toctree-l1"><a class="reference internal" href="extending.html">Extending Renard</a></li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
         </div>

diff --git a/searchindex.js b/searchindex.js
-Original file line number
+Diff line change
@@ Expand Up / @@ -51,6 +51,7 @@ @@
     </ul>
     </li>
     <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+    <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
     </ul>
             </div>
@@ Expand Down @@