From 46a00aaaa4dedb07ed28237524ef4ebb57d02ea2 Mon Sep 17 00:00:00 2001 From: Mahmoud Mazouz Date: Fri, 1 Mar 2024 14:41:25 +0100 Subject: [PATCH 1/3] chore: Add Rust Read the Docs system dependency --- .readthedocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index 96b6fd36..02beda86 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -27,6 +27,7 @@ build: os: ubuntu-22.04 tools: python: "3.8" + rust: "latest" # Build documentation with MkDocs #mkdocs: From a59f0a16c1f39244bb7b2396c974ac01fe049c31 Mon Sep 17 00:00:00 2001 From: Mahmoud Mazouz Date: Fri, 1 Mar 2024 15:00:54 +0100 Subject: [PATCH 2/3] feat: Build wheel in Read the Docs build --- .readthedocs.yml | 8 ++++---- docs/conf.py | 3 --- docs/requirements.txt | 4 +--- 3 files changed, 5 insertions(+), 10 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 02beda86..30b8ac3d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -28,10 +28,9 @@ build: tools: python: "3.8" rust: "latest" - -# Build documentation with MkDocs -#mkdocs: -# configuration: mkdocs.yml + jobs: + pre_build: + - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH maturin develop # Optionally build your docs in additional formats such as PDF formats: @@ -41,3 +40,4 @@ formats: python: install: - requirements: docs/requirements.txt + - requirements: requirements-dev.txt diff --git a/docs/conf.py b/docs/conf.py index 11cb0d7c..466644c1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,9 +23,6 @@ # -- Project setup -------------------------------------------------------------- -# NOTE: as zenoh-python is developped in Rust, it must be compiled and install in Python environment -# in order to be imported here (and the Sphinx autodoc extension to load the doc from the compiled code) -# For readthedocs.org, zenoh-python is added in docs/requirements.txt so it get it from pypi.org import zenoh # -- Project information ----------------------------------------------------- diff --git a/docs/requirements.txt b/docs/requirements.txt index d300fc6d..4fedba9f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1 @@ -### NOTE: Read the Docs cannot build the Rust code, and thus is not able to import zenoh -### unless it's installed from pypi.org as a requirement -eclipse-zenoh == 0.11.0-dev +sphinx_rtd_theme==2.0.0 From abb54bb63513c1d2362d6065bf6f2c92187dd783 Mon Sep 17 00:00:00 2001 From: Mahmoud Mazouz Date: Fri, 1 Mar 2024 15:44:47 +0100 Subject: [PATCH 3/3] fix: Remove mention of nightly wheel in README --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 497c5245..e7b50ec5 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,6 @@ Install the latest available version using `pip`: pip install eclipse-zenoh ``` -To install the latest nightly build of the development version do: -``` -pip install eclipse-zenoh-nightly -``` - :warning:WARNING:warning: zenoh-python is developped in Rust. On Pypi.org we provide binary wheels for the most common platforms (Linux x86_64, i686, ARMs, MacOS universal2 and Windows amd64). But also a source distribution package for other platforms. However, for `pip` to be able to build this source distribution, there are some prerequisites: