Update Sphinx documentation, commit 092a508 [skip ci].

bluescarni · Oct 6, 2023 · 831c4c2 · 831c4c2
1 parent aabd7a9
commit 831c4c2
Show file tree

Hide file tree

Showing 40 changed files with 58 additions and 44 deletions.
diff --git a/_sources/changelog.rst b/_sources/changelog.rst
@@ -1,12 +1,19 @@
 Changelog
 =========
 
-2.0.1 (unreleased)
+3.0.0 (unreleased)
 ------------------
 
 Fix
 ~~~
 
+- Prevent accidental leaking in the public headers of
+  serialisation implementation details
+  (`#350 <https://github.com/bluescarni/heyoka/pull/350>`__).
+- Fix wrong version compatibility setting in the CMake config-file package
+  (`#350 <https://github.com/bluescarni/heyoka/pull/350>`__).
+- Work around test failure on ARM + LLVM 17
+  (`#350 <https://github.com/bluescarni/heyoka/pull/350>`__).
 - Fix orbital elements singularity when using the VSOP2013
   theory at low precision
   (`#348 <https://github.com/bluescarni/heyoka/pull/348>`__).

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '2.0.1',
+    VERSION: '3.0.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/acknowledgement.html b/acknowledgement.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Acknowledgement &#8212; heyoka 2.0.1 documentation</title>
+    <title>Acknowledgement &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/ad_notes.html b/ad_notes.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Notes on automatic differentiation &#8212; heyoka 2.0.1 documentation</title>
+    <title>Notes on automatic differentiation &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/advanced_tutorials.html b/advanced_tutorials.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Advanced tutorials &#8212; heyoka 2.0.1 documentation</title>
+    <title>Advanced tutorials &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/api_reference.html b/api_reference.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>API Reference &#8212; heyoka 2.0.1 documentation</title>
+    <title>API Reference &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/basic_tutorials.html b/basic_tutorials.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Basic tutorials &#8212; heyoka 2.0.1 documentation</title>
+    <title>Basic tutorials &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/benchmarks.html b/benchmarks.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Benchmarks &#8212; heyoka 2.0.1 documentation</title>
+    <title>Benchmarks &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/bibliography.html b/bibliography.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Bibliography &#8212; heyoka 2.0.1 documentation</title>
+    <title>Bibliography &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/breaking_changes.html b/breaking_changes.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Breaking changes &#8212; heyoka 2.0.1 documentation</title>
+    <title>Breaking changes &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/changelog.html b/changelog.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Changelog &#8212; heyoka 2.0.1 documentation</title>
+    <title>Changelog &#8212; heyoka 3.0.0 documentation</title>
 
 
 
@@ -374,7 +374,7 @@ <h2> Contents </h2>
             </div>
             <nav aria-label="Page">
                 <ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#unreleased">2.0.1 (unreleased)</a><ul class="nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#unreleased">3.0.0 (unreleased)</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#fix">Fix</a></li>
 </ul>
 </li>
@@ -528,10 +528,17 @@ <h2> Contents </h2>
   <section id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this heading">#</a></h1>
 <section id="unreleased">
-<h2>2.0.1 (unreleased)<a class="headerlink" href="#unreleased" title="Permalink to this heading">#</a></h2>
+<h2>3.0.0 (unreleased)<a class="headerlink" href="#unreleased" title="Permalink to this heading">#</a></h2>
 <section id="fix">
 <h3>Fix<a class="headerlink" href="#fix" title="Permalink to this heading">#</a></h3>
 <ul class="simple">
+<li><p>Prevent accidental leaking in the public headers of
+serialisation implementation details
+(<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/350">#350</a>).</p></li>
+<li><p>Fix wrong version compatibility setting in the CMake config-file package
+(<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/350">#350</a>).</p></li>
+<li><p>Work around test failure on ARM + LLVM 17
+(<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/350">#350</a>).</p></li>
 <li><p>Fix orbital elements singularity when using the VSOP2013
 theory at low precision
 (<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/348">#348</a>).</p></li>
@@ -1487,7 +1494,7 @@ <h2>0.1.0 (2020-12-18)<a class="headerlink" href="#id84" title="Permalink to thi
   </div>
   <nav class="bd-toc-nav page-toc">
     <ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#unreleased">2.0.1 (unreleased)</a><ul class="nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#unreleased">3.0.0 (unreleased)</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#fix">Fix</a></li>
 </ul>
 </li>

diff --git a/definitions.html b/definitions.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Macros and definitions &#8212; heyoka 2.0.1 documentation</title>
+    <title>Macros and definitions &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/exceptions.html b/exceptions.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Exceptions &#8212; heyoka 2.0.1 documentation</title>
+    <title>Exceptions &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/expression.html b/expression.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Expressions &#8212; heyoka 2.0.1 documentation</title>
+    <title>Expressions &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/expression_system.html b/expression_system.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Expression system &#8212; heyoka 2.0.1 documentation</title>
+    <title>Expression system &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/func.html b/func.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Functions &#8212; heyoka 2.0.1 documentation</title>
+    <title>Functions &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/genindex.html b/genindex.html
@@ -8,7 +8,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; heyoka 2.0.1 documentation</title>
+    <title>Index &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/index.html b/index.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>heyoka &#8212; heyoka 2.0.1 documentation</title>
+    <title>heyoka &#8212; heyoka 3.0.0 documentation</title>
 
 
 
@@ -556,7 +556,7 @@ <h1>heyoka<a class="headerlink" href="#heyoka" title="Permalink to this heading"
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">2.0.1 (unreleased)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">3.0.0 (unreleased)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">2.0.0 (2023-09-22)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">1.0.0 (2023-08-10)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">0.21.0 (2023-02-16)</a></li>

diff --git a/install.html b/install.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Installation &#8212; heyoka 2.0.1 documentation</title>
+    <title>Installation &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/kwargs.html b/kwargs.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Keyword arguments &#8212; heyoka 2.0.1 documentation</title>
+    <title>Keyword arguments &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/namespaces.html b/namespaces.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Namespaces &#8212; heyoka 2.0.1 documentation</title>
+    <title>Namespaces &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/number.html b/number.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Numerical constants &#8212; heyoka 2.0.1 documentation</title>
+    <title>Numerical constants &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/param.html b/param.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Runtime parameters &#8212; heyoka 2.0.1 documentation</title>
+    <title>Runtime parameters &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/search.html b/search.html
@@ -7,7 +7,7 @@
 
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - heyoka 2.0.1 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/searchindex.js b/searchindex.js
diff --git a/tut_adaptive.html b/tut_adaptive.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>The adaptive integrator &#8212; heyoka 2.0.1 documentation</title>
+    <title>The adaptive integrator &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_adaptive_custom.html b/tut_adaptive_custom.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Customising the adaptive integrator &#8212; heyoka 2.0.1 documentation</title>
+    <title>Customising the adaptive integrator &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_arbitrary_precision.html b/tut_arbitrary_precision.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Computations in arbitrary precision &#8212; heyoka 2.0.1 documentation</title>
+    <title>Computations in arbitrary precision &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_batch_mode.html b/tut_batch_mode.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Batch mode &#8212; heyoka 2.0.1 documentation</title>
+    <title>Batch mode &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_d_output.html b/tut_d_output.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Dense &amp; continuous output &#8212; heyoka 2.0.1 documentation</title>
+    <title>Dense &amp; continuous output &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_ensemble.html b/tut_ensemble.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Ensemble propagations &#8212; heyoka 2.0.1 documentation</title>
+    <title>Ensemble propagations &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_events.html b/tut_events.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Event detection &#8212; heyoka 2.0.1 documentation</title>
+    <title>Event detection &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_expression_system.html b/tut_expression_system.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>The expression system &#8212; heyoka 2.0.1 documentation</title>
+    <title>The expression system &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_extended_precision.html b/tut_extended_precision.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Computations in extended precision &#8212; heyoka 2.0.1 documentation</title>
+    <title>Computations in extended precision &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_nonauto.html b/tut_nonauto.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Non-autonomous systems &#8212; heyoka 2.0.1 documentation</title>
+    <title>Non-autonomous systems &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_parallel_mode.html b/tut_parallel_mode.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Parallel mode &#8212; heyoka 2.0.1 documentation</title>
+    <title>Parallel mode &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_param.html b/tut_param.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Runtime parameters &#8212; heyoka 2.0.1 documentation</title>
+    <title>Runtime parameters &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_s11n.html b/tut_s11n.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Serialisation &#8212; heyoka 2.0.1 documentation</title>
+    <title>Serialisation &#8212; heyoka 3.0.0 documentation</title>
 
 
 

diff --git a/tut_taylor_method.html b/tut_taylor_method.html
@@ -9,7 +9,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Taylor’s method &#8212; heyoka 2.0.1 documentation</title>
+    <title>Taylor’s method &#8212; heyoka 3.0.0 documentation</title>