speculos 0.9.8.dev4__tar.gz → 0.9.8.dev8__tar.gz

speculos-0.9.8.dev8/.github/workflows/documentation.yml

@@ -0,0 +1,47 @@
+name: Documentation generation & update
+
+on:
+  push:
+    tags:
+      - '*'
+    branches:
+      - develop
+      - master
+  pull_request:
+    branches:
+      - develop
+      - master
+
+jobs:
+  generate:
+    name: Generate the documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Python dependencies
+        run: |
+          pip install -r docs/requirements.txt
+      - name: Generate the documentation
+        run: (cd docs && make html)
+      - name: Upload documentation bundle
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs/build/html/
+
+  deploy:
+    name: Deploy the documentation on Github pages
+    runs-on: ubuntu-latest
+    needs: generate
+    if: github.event_name == 'push'  && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/'))
+    steps:
+      - name: Download documentation bundle
+        uses: actions/download-artifact@v4
+      - name: Deploy documentation on pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: documentation/

{speculos-0.9.8.dev4/speculos.egg-info → speculos-0.9.8.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: speculos
-Version: 0.9.8.dev4
+Version: 0.9.8.dev8
 Summary: Ledger Blue, Stax, Flex and Nano S/S+/X application emulator
 Author-email: Ledger <hello@ledger.fr>
 Project-URL: Homepage, https://github.com/LedgerHQ/speculos

speculos-0.9.8.dev8/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

speculos-0.9.8.dev8/docs/conf.py

@@ -0,0 +1,32 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Speculos'
+copyright = '2024, Ledger'
+author = 'Ledger'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['myst_parser']
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ['_static']

speculos-0.9.8.dev8/docs/dev/index.rst

@@ -0,0 +1,10 @@
+Developer documentation
+=======================
+
+.. toctree::
+   :maxdepth: 1
+
+   getting_started
+   tests
+   internals
+   ci

speculos-0.9.8.dev8/docs/index.rst

@@ -0,0 +1,44 @@
+Speculos documentation
+======================
+
+`Source code <https://github.com/LedgerHQ/speculos>`_
+
+.. toctree::
+   :maxdepth: 1
+
+   installation/index
+   user/index
+   dev/index
+
+
+Users
+-----
+
+Installation and basic usage
+++++++++++++++++++++++++++++
+
+- Linux: :doc:`Requirements and build<installation/build>`
+- Mac OS (and Linux) users: :doc:`How to use the Docker image<user/docker>` with VNC
+- Mac M1 users: :doc:`How to build and use the Docker image<user/macm1>`
+- Windows users: :doc:`Using speculos from WSL 2<installation/wsl>`
+- :doc:`Usage<user/usage>`
+
+Interaction with an app
++++++++++++++++++++++++
+
+- :doc:`How to send APDUs to an app (and more)<user/clients>`
+- :doc:`How to use gdb to debug an app<user/debug>`
+- :doc:`How to automate actions thanks to the REST API<user/api>`
+
+For advanced users
+++++++++++++++++++
+
+- :doc:`Automation: press buttons automatically<user/automation>`
+- :doc:`Semihosting as an additional debug mechanism<user/semihosting>`
+
+Speculos developers
+-------------------
+
+- :doc:`CI (Continuous Integration)<dev/ci>`
+- :doc:`Internals<dev/internals>`
+- :doc:`How to run tests<dev/tests>`

speculos-0.9.8.dev8/docs/installation/index.rst

@@ -0,0 +1,8 @@
+Installation
+============
+
+.. toctree::
+   :maxdepth: 1
+
+   build
+   wsl

speculos-0.9.8.dev8/docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx-rtd-theme
+myst-parser

{speculos-0.9.8.dev4 → speculos-0.9.8.dev8}/docs/user/api.md

@@ -31,4 +31,4 @@ curl -o screenshot.png http://127.0.0.1:5000/screenshot
 
 There is a web user interface running directly on [http://127.0.0.1:5000](http://127.0.0.1:5000), which communicates with the API:
 
-![screenshot btc nano s](../screenshot-api-nanos-btc.png)
+![screenshot btc nano s](../_static/screenshot-api-nanos-btc.png)

{speculos-0.9.8.dev4 → speculos-0.9.8.dev8}/docs/user/docker.md

@@ -1,7 +1,3 @@
----
-sort: 2
----
-
 # Docker
 
 ## How to use the Docker image

speculos-0.9.8.dev8/docs/user/index.rst

@@ -0,0 +1,14 @@
+User
+====
+
+.. toctree::
+   :maxdepth: 1
+
+   api
+   automation
+   clients
+   debug
+   docker
+   macm1
+   semihosting
+   usage

{speculos-0.9.8.dev4 → speculos-0.9.8.dev8}/docs/user/macm1.md

@@ -1,4 +1,4 @@
-# Docker
+# Docker - for Mac M1
 
 ## How to build the Docker image
 
@@ -69,4 +69,4 @@ docker-compose up [-d]
 ```
 > Default configuration is nanos / 2.0 / btc.elf / seed "secret"
 
-Edit `docker-compose.yml` to configure port forwarding and environment variables that fit your needs.
+Edit `docker-compose.yml` to configure port forwarding and environment variables that fit your needs.

{speculos-0.9.8.dev4 → speculos-0.9.8.dev8}/speculos/__version__.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.9.8.dev4'
-__version_tuple__ = version_tuple = (0, 9, 8, 'dev4')
+__version__ = version = '0.9.8.dev8'
+__version_tuple__ = version_tuple = (0, 9, 8, 'dev8')

{speculos-0.9.8.dev4 → speculos-0.9.8.dev8/speculos.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: speculos
-Version: 0.9.8.dev4
+Version: 0.9.8.dev8
 Summary: Ledger Blue, Stax, Flex and Nano S/S+/X application emulator
 Author-email: Ledger <hello@ledger.fr>
 Project-URL: Homepage, https://github.com/LedgerHQ/speculos

{speculos-0.9.8.dev4 → speculos-0.9.8.dev8}/speculos.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ lgtm.yml
 pyproject.toml
 setup.py
 .github/workflows/continuous-integration-workflow.yml
+.github/workflows/documentation.yml
 .github/workflows/fast-checks.yml
 .github/workflows/force-rebase.yml
 .github/workflows/reusable_ragger_tests_latest_speculos.yml
@@ -46,24 +47,26 @@ apps/nanox#btc#1.2#57272a0f.elf
 apps/nanox#btc#2.0.2#1c8db8da.elf
 apps/nanox#btc-test#2.0.2#1c8db8da.elf
 docs/CNAME
-docs/_config.yml
-docs/index.md
-docs/screenshot-api-nanos-btc.png
-docs/screenshot-btc-nanos.png
+docs/Makefile
+docs/conf.py
+docs/index.rst
+docs/requirements.txt
+docs/_static/screenshot-api-nanos-btc.png
+docs/_static/screenshot-btc-nanos.png
 docs/dev/ci.md
 docs/dev/getting_started.md
-docs/dev/index.md
+docs/dev/index.rst
 docs/dev/internals.md
 docs/dev/tests.md
 docs/installation/build.md
-docs/installation/index.md
+docs/installation/index.rst
 docs/installation/wsl.md
 docs/user/api.md
 docs/user/automation.md
 docs/user/clients.md
 docs/user/debug.md
 docs/user/docker.md
-docs/user/index.md
+docs/user/index.rst
 docs/user/macm1.md
 docs/user/semihosting.md
 docs/user/usage.md

speculos-0.9.8.dev4/docs/_config.yml

@@ -1,7 +0,0 @@
-title: Speculos documentation
-lang: en
-
-remote_theme: rundocs/jekyll-rtd-theme
-
-exclude:
-  - screenshot-btc-nanos.png

speculos-0.9.8.dev4/docs/dev/index.md

@@ -1,5 +0,0 @@
----
-sort: 3
----
-
-## Developer documentation

speculos-0.9.8.dev4/docs/index.md

@@ -1,31 +0,0 @@
-# Speculos documentation
-
-[Source code](https://github.com/LedgerHQ/speculos).
-
-## Users
-
-### Installation and basic usage
-
-- Linux users: [Requirements and build](installation/build.md)
-- Mac OS (and Linux) users: [How to use the Docker image](user/docker.md) with VNC
-- Mac M1 users: [How to build and use the Docker image](user/macm1.md)
-- Windows users: [Using speculos from WSL 2](installation/wsl.md)
-- [Usage](user/usage.md)
-
-### Interaction with an app
-
-- [How to send APDUs to an app (and more)](user/clients.md)
-- [How to use gdb to debug an app](user/debug.md)
-- [How to automate actions thanks to the REST API](user/api.md)
-
-### For advanced users
-
-- [Automation: press buttons automatically](user/automation.md)
-- [Semihosting as an additional debug mechanism](user/semihosting.md)
-
-
-## Speculos developers
-
-- [CI (Continuous Integration)](dev/ci.md)
-- [Internals](dev/internals.md)
-- [How to run tests](dev/tests.md)

speculos-0.9.8.dev4/docs/installation/index.md

@@ -1,5 +0,0 @@
----
-sort: 1
----
-
-## Installation

speculos-0.9.8.dev4/docs/user/index.md

@@ -1,5 +0,0 @@
----
-sort: 2
----
-
-## User