Deployed c76b5ca with MkDocs version: 1.6.1

quarkslab · Dec 19, 2024 · 9a70b96 · 9a70b96
1 parent c16a734
commit 9a70b96
Show file tree

Hide file tree

Showing 4 changed files with 155 additions and 20 deletions.
diff --git a/changelog/index.html b/changelog/index.html
@@ -87,7 +87,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#v021opensourcing" class="md-skip">
+        <a href="#v022graph-customization-features" class="md-skip">
           Skip to content
         </a>
 
@@ -498,6 +498,39 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#v022graph-customization-features" class="md-nav__link">
+    <span class="md-ellipsis">
+      v0.2.2—Graph Customization Features
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="v0.2.2—Graph Customization Features">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#features" class="md-nav__link">
+    <span class="md-ellipsis">
+      Features
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#fixes" class="md-nav__link">
+    <span class="md-ellipsis">
+      Fixes
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#v021opensourcing" class="md-nav__link">
     <span class="md-ellipsis">
@@ -509,7 +542,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#features" class="md-nav__link">
+  <a href="#features_1" class="md-nav__link">
     <span class="md-ellipsis">
       Features
     </span>
@@ -518,7 +551,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#fixes" class="md-nav__link">
+  <a href="#fixes_1" class="md-nav__link">
     <span class="md-ellipsis">
       Fixes
     </span>
@@ -542,7 +575,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#features_1" class="md-nav__link">
+  <a href="#features_2" class="md-nav__link">
     <span class="md-ellipsis">
       Features
     </span>
@@ -551,7 +584,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#fixes_1" class="md-nav__link">
+  <a href="#fixes_2" class="md-nav__link">
     <span class="md-ellipsis">
       Fixes
     </span>
@@ -625,6 +658,39 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#v022graph-customization-features" class="md-nav__link">
+    <span class="md-ellipsis">
+      v0.2.2—Graph Customization Features
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="v0.2.2—Graph Customization Features">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#features" class="md-nav__link">
+    <span class="md-ellipsis">
+      Features
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#fixes" class="md-nav__link">
+    <span class="md-ellipsis">
+      Fixes
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#v021opensourcing" class="md-nav__link">
     <span class="md-ellipsis">
@@ -636,7 +702,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#features" class="md-nav__link">
+  <a href="#features_1" class="md-nav__link">
     <span class="md-ellipsis">
       Features
     </span>
@@ -645,7 +711,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#fixes" class="md-nav__link">
+  <a href="#fixes_1" class="md-nav__link">
     <span class="md-ellipsis">
       Fixes
     </span>
@@ -669,7 +735,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#features_1" class="md-nav__link">
+  <a href="#features_2" class="md-nav__link">
     <span class="md-ellipsis">
       Features
     </span>
@@ -678,7 +744,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#fixes_1" class="md-nav__link">
+  <a href="#fixes_2" class="md-nav__link">
     <span class="md-ellipsis">
       Fixes
     </span>
@@ -720,23 +786,35 @@
 
   <h1>Changelog</h1>
 
-<h2 id="v021opensourcing">v0.2.1—Opensourcing</h2>
+<h2 id="v022graph-customization-features">v0.2.2—Graph Customization Features</h2>
 <h3 id="features">Features</h3>
 <ul>
-<li>add small details in the documentation.</li>
+<li>Class member publicity (internal, private, public) could now be set with the <code>SourcetrailDB.record_{public, default, private}_access</code> methods.</li>
+<li>Integrate customization features provided by NumbatUI (<em>cf</em> <a href="https://quarkslab.github.io/numbat/customization/">dedicated doc page</a> for details).</li>
 </ul>
 <h3 id="fixes">Fixes</h3>
 <ul>
+<li>Update CI to replace EoL actions versions.</li>
+<li>Parent directory iteration</li>
+</ul>
+<p><strong>Full Changelog</strong>: <a href="https://github.com/quarkslab/numbat/compare/v0.2.1...v0.2.2">https://github.com/quarkslab/numbat/compare/v0.2.1...v0.2.2</a></p>
+<h2 id="v021opensourcing">v0.2.1—Opensourcing</h2>
+<h3 id="features_1">Features</h3>
+<ul>
+<li>add small details in the documentation.</li>
+</ul>
+<h3 id="fixes_1">Fixes</h3>
+<ul>
 <li>Tests with correct modules name</li>
 </ul>
 <p><strong>Full Changelog</strong>: <a href="https://github.com/quarkslab/numbat/compare/v0.2.0...v0.2.1">https://github.com/quarkslab/numbat/compare/v0.2.0...v0.2.1</a></p>
 <h2 id="v020">v0.2.0</h2>
-<h3 id="features_1">Features</h3>
+<h3 id="features_2">Features</h3>
 <ul>
 <li>add a cache system for names/id to avoid doing DB request to obtain the id associated to a given name</li>
 <li>add the classmethod <code>SourcetrailDB.exists</code> to check if a path correspond to an existing db</li>
 </ul>
-<h3 id="fixes_1">Fixes</h3>
+<h3 id="fixes_2">Fixes</h3>
 <ul>
 <li>None</li>
 </ul>

diff --git a/customization/index.html b/customization/index.html
@@ -666,6 +666,10 @@
 
 <h1 id="customization">Customization</h1>
 <p>Numbat also offers a few customization options, mostly to help with mapping data other than source code.</p>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>These features can only be viewable with <a href="https://github.com/quarkslab/NumbatUI">NumbatUI</a>, Quarkslab fork of Sourcetrail, which is currently work in progress and really unstable. </p>
+</div>
 <h2 id="custom-node-types">Custom node types</h2>
 <p>Non-source code data might not fit in any of the existing node types, so we can use the <a href="../public_api/#numbat.SourcetrailDB.set_node_type"><code>set_node_type</code></a> function to change them to types that are more adapted.</p>
 <p>The existing node types are: <code>annotation</code> <code>built-in type</code> <code>class</code> <code>enum</code> <code>enum constant</code> <code>field</code> <code>file</code> <code>function</code> <code>global variable</code> <code>interface</code> <code>macro</code> <code>method</code> <code>module</code> <code>namespace</code> <code>package</code> <code>struct</code> <code>symbol</code> <code>type</code> <code>type parameter</code> <code>typedef</code> <code>union</code></p>

diff --git a/index.html b/index.html
@@ -350,12 +350,36 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#authors" class="md-nav__link">
+  <a href="#authors-maintainers" class="md-nav__link">
     <span class="md-ellipsis">
-      Authors
+      Authors &amp; Maintainers
     </span>
   </a>
 
+    <nav class="md-nav" aria-label="Authors & Maintainers">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#current" class="md-nav__link">
+    <span class="md-ellipsis">
+      Current
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#past" class="md-nav__link">
+    <span class="md-ellipsis">
+      Past
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
     </ul>
@@ -648,12 +672,36 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#authors" class="md-nav__link">
+  <a href="#authors-maintainers" class="md-nav__link">
+    <span class="md-ellipsis">
+      Authors &amp; Maintainers
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Authors & Maintainers">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#current" class="md-nav__link">
+    <span class="md-ellipsis">
+      Current
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#past" class="md-nav__link">
     <span class="md-ellipsis">
-      Authors
+      Past
     </span>
   </a>
 
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
     </ul>
@@ -679,7 +727,7 @@ <h1 id="numbat">Numbat</h1>
 <p>Numbat is an API to create and manipulate Sourcetrail databases. <a href="https://github.com/CoatiSoftware/Sourcetrail">Sourcetrail</a> is a code source
 explorer which allows users to navigate through the different components (functions, classes, types, etc.) easily.</p>
 <p>Numbat main goal is to offer a full-python SDK given the fact that the current one, SourcetrailDB cannot be used anymore efficiently. It is not user-friendly at first sight, need to be compiled to provide Python bindings and, moreover, it is no longer maintained. Finally, we have added some little new features as finding an element in the database.</p>
-<p>With Numbat, you will be able to visualize your data quickly with the nice graphical Sourcetrail interface. For example, <a href="https://github.com/quarkslab/pyrrha">Pyrrha</a> uses Numbat to map firmware structure.</p>
+<p>With Numbat, you will be able to visualize your data quickly with the nice graphical Sourcetrail interface. For example, <a href="https://quarkslab.github.io/pyrrha/">Pyrrha</a> uses Numbat to map firmware structure.</p>
 <h2 id="installation">Installation</h2>
 <p>Numbat is available on <code>pypi</code>.
 <div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip<span class="w"> </span>install<span class="w"> </span>numbat
@@ -731,11 +779,16 @@ <h2 id="basic-usage">Basic Usage</h2>
 </span><span id="__span-4-19"><a id="__codelineno-4-19" name="__codelineno-4-19" href="#__codelineno-4-19"></a><span class="n">db</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
 </span><span id="__span-4-20"><a id="__codelineno-4-20" name="__codelineno-4-20" href="#__codelineno-4-20"></a><span class="n">db</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
 </span></code></pre></div>
-<h2 id="authors">Authors</h2>
+<h2 id="authors-maintainers">Authors &amp; Maintainers</h2>
+<h3 id="current">Current</h3>
 <ul>
 <li>Sami Babigeon (@sbabigeon), Quarkslab</li>
 <li>Eloïse Brocas (@ebrocas), Quarkslab</li>
 </ul>
+<h3 id="past">Past</h3>
+<ul>
+<li>Pascal Wu (@pwu42), during his internship at Quarkslab</li>
+</ul>
 <p>The logo is a creation of Benoît Forgette and Sami Babigeon.</p>
 
 

diff --git a/search/search_index.json b/search/search_index.json