Skip to content

Update RTD integration #2

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.

Sign up for GitHub

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

Merged
kostrykin merged 7 commits into from
May 13, 2025
Merged

Update RTD integration #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
051db3f
Add `LIBCARNA_PYTHON_NBSPHINX_EXECUTE` environment variable
kostrykin May 13, 2025
5407334
Add docs building for testing to CI
kostrykin May 13, 2025
724260a
Update RTD integration, remove doc building from CI
kostrykin May 13, 2025
ff83df7
Update docs/conf.py
kostrykin May 13, 2025
8a6c488
Update .readthedocs.yaml
kostrykin May 13, 2025
1577285
Update .readthedocs.yaml
kostrykin May 13, 2025
410c4ff
Update .readthedocs.yaml
kostrykin May 13, 2025
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
12 changes: 6 additions & 6 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,6 @@ sphinx:
conda:
environment: environment.yml

# Install doc-building dependencies
python:
install:
- requirements: docs/requirements.txt

# Specify the build process
build:
os: ubuntu-24.04
Expand All @@ -25,4 +20,9 @@ build:
jobs:
install:
- bash ./linux_build.bash
- pip install libcarna_python-*.whl
- pip install dist/libcarna_python-*.whl
pre_build:
- pip install -r docs/requirements.txt
build:
html:
- LIBCARNA_PYTHON_NBSPHINX_EXECUTE=never sphinx-build -M html docs $READTHEDOCS_OUTPUT
7 changes: 4 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
import sys

LIBCARNA_PYTHON_PATH = os.environ.get('LIBCARNA_PYTHON_PATH')
sys.path.append(LIBCARNA_PYTHON_PATH)
os.environ['PYTHONPATH'] = LIBCARNA_PYTHON_PATH + ':' + os.environ.get('PYTHONPATH', '')
if LIBCARNA_PYTHON_PATH is not None:
sys.path.append(LIBCARNA_PYTHON_PATH)
os.environ['PYTHONPATH'] = LIBCARNA_PYTHON_PATH + ':' + os.environ.get('PYTHONPATH', '')

nbsphinx_execute = 'always'
nbsphinx_execute = os.environ.get('LIBCARNA_PYTHON_NBSPHINX_EXECUTE', 'always')
Loading