Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Documentation build #154

Merged
merged 3 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ build:
os: ubuntu-22.04
tools:
python: "3.8"

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml
rust: "latest"
jobs:
pre_build:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH maturin develop

# Optionally build your docs in additional formats such as PDF
formats:
Expand All @@ -40,3 +40,4 @@ formats:
python:
install:
- requirements: docs/requirements.txt
- requirements: requirements-dev.txt
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 0 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 -----------------------------------------------------
Expand Down
4 changes: 1 addition & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -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