Skip to content

Commit

Permalink
Update Sphinx documentation, commit 4c7ad8f [skip ci].
Browse files Browse the repository at this point in the history
  • Loading branch information
bluescarni committed Dec 10, 2023
1 parent 42becda commit 51352c5
Show file tree
Hide file tree
Showing 90 changed files with 580 additions and 548 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
14 changes: 14 additions & 0 deletions _sources/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,20 @@
Changelog
=========

4.0.0 (unreleased)
------------------

Changes
~~~~~~~

- The binary wheels are now built on top of ``manylinux2014``
(`#153 <https://github.com/bluescarni/heyoka.py/pull/153>`__).
- heyoka.py now requires C++20 when building from source
(`#153 <https://github.com/bluescarni/heyoka.py/pull/153>`__).
- heyoka.py now requires version 4.0.0 of the
heyoka C++ library
(`#153 <https://github.com/bluescarni/heyoka.py/pull/153>`__).

3.2.0 (2023-11-29)
------------------

Expand Down
12 changes: 5 additions & 7 deletions _sources/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Dependencies
heyoka.py has several Python and C++ dependencies. On the C++ side, heyoka.py depends on:

* the `heyoka C++ library <https://github.com/bluescarni/heyoka>`__,
version 3.2.x (**mandatory**),
version 4.x (**mandatory**),
* the `Boost <https://www.boost.org/>`__ C++ libraries (**mandatory**),
* the `{fmt} <https://fmt.dev/latest/index.html>`__ library (**mandatory**),
* the `TBB <https://github.com/oneapi-src/oneTBB>`__ library (**mandatory**),
Expand Down Expand Up @@ -89,12 +89,10 @@ Installation from source
------------------------

heyoka.py is written in modern C++, and it requires a compiler able to understand
at least C++17. The library is regularly tested on
a continuous integration pipeline which currently includes:

* GCC 9 on Linux,
* Clang 11 on OSX,
* MSVC 2019 on Windows.
at least C++20. The library is regularly tested on
a continuous integration pipeline which currently includes several
compilers (GCC, Clang, MSVC) on several operating systems (Linux, OSX, Windows)
and several CPU architectures (x86-64, 64-bit ARM and 64-bit PowerPC).

In addition to the C++ dependencies enumerated :ref:`earlier <installation_deps>`,
installation from source requires also:
Expand Down
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '3.2.0',
VERSION: '4.0.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
6 changes: 3 additions & 3 deletions acknowledgement.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.py 3.2.0 documentation</title>
<title>Acknowledgement &#8212; heyoka.py 4.0.0 documentation</title>



Expand Down Expand Up @@ -133,8 +133,8 @@



<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 3.2.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 3.2.0 documentation - Home"/>`);</script>
<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 4.0.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 4.0.0 documentation - Home"/>`);</script>


</a></div>
Expand Down
6 changes: 3 additions & 3 deletions advanced_tutorials.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 &#8212; heyoka.py 3.2.0 documentation</title>
<title>Advanced &#8212; heyoka.py 4.0.0 documentation</title>



Expand Down Expand Up @@ -133,8 +133,8 @@



<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 3.2.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 3.2.0 documentation - Home"/>`);</script>
<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 4.0.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 4.0.0 documentation - Home"/>`);</script>


</a></div>
Expand Down
6 changes: 3 additions & 3 deletions basic_tutorials.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 &#8212; heyoka.py 3.2.0 documentation</title>
<title>Basic &#8212; heyoka.py 4.0.0 documentation</title>



Expand Down Expand Up @@ -133,8 +133,8 @@



<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 3.2.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 3.2.0 documentation - Home"/>`);</script>
<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 4.0.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 4.0.0 documentation - Home"/>`);</script>


</a></div>
Expand Down
6 changes: 3 additions & 3 deletions benchmarks.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.py 3.2.0 documentation</title>
<title>Benchmarks &#8212; heyoka.py 4.0.0 documentation</title>



Expand Down Expand Up @@ -133,8 +133,8 @@



<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 3.2.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 3.2.0 documentation - Home"/>`);</script>
<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 4.0.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 4.0.0 documentation - Home"/>`);</script>


</a></div>
Expand Down
6 changes: 3 additions & 3 deletions breaking_changes.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.py 3.2.0 documentation</title>
<title>Breaking changes &#8212; heyoka.py 4.0.0 documentation</title>



Expand Down Expand Up @@ -133,8 +133,8 @@



<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 3.2.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 3.2.0 documentation - Home"/>`);</script>
<img src="_static/white_logo.png" class="logo__image only-light" alt="heyoka.py 4.0.0 documentation - Home"/>
<script>document.write(`<img src="_static/white_logo.png" class="logo__image only-dark" alt="heyoka.py 4.0.0 documentation - Home"/>`);</script>


</a></div>
Expand Down
Loading

0 comments on commit 51352c5

Please sign in to comment.