Skip to content

Commit

Permalink
update python version in the docs builder
Browse files Browse the repository at this point in the history
  • Loading branch information
BlaiseMuhirwa committed Jan 16, 2025
1 parent cd2c9ed commit 06ae33e
Show file tree
Hide file tree
Showing 7 changed files with 5 additions and 37 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/build-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ jobs:

- name: Generate Doxygen & Sphinx documentation
run: |
# using the -f flag to force building the Python library.
./generate_docs.sh -f
./generate_docs.sh
- name: Create .nojekyll file
run: |
Expand Down
7 changes: 0 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,6 @@ node-access-distributions
# PYcache
**/__pycache__

# Python wheel related folders/files
flatnav_python/flatnav.egg-info/
flatnav_python/poetry.lock
flatnav_python/dist
flatnav_python/__pycache__
flatnav_python/unit_tests/__pycache__


# Documentation related files
docs/_build/
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ ENV PATH="${POETRY_HOME}/bin:${PATH}"
WORKDIR ${FLATNAV_PATH}

# Copy source code
COPY flatnav/ ./flatnav/
COPY include/flatnav/ ./flatnav/
COPY python-bindings/ ./python-bindings/
COPY experiments/ ./experiments/

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
CPP_FILES := $(wildcard flatnav/**/*.h flatnav/**/*.cpp flatnav_python/*.cpp tools/*.cpp developmental-features/**/*.h)
CPP_FILES := $(wildcard flatnav/**/*.h flatnav/**/*.cpp python-bindings/*.cpp tools/*.cpp developmental-features/**/*.h)
CIBUILDWHEEL_VERSION := 2.22.0


Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ Example Usage:
./build.sh -t -e -v
```

To build the Python bindings, follow instructions [here](https://github.com/BlaiseMuhirwa/flatnav/blob/main/flatnav_python/README.md). There are also examples for how to use the library to build an index and run queries on top of it [here](https://github.com/BlaiseMuhirwa/flatnav/blob/main/flatnav_python/unit_tests/test_index.py).

### Support for SIMD Extensions

We currently support SIMD extensions for certain platforms as detailed below.
Expand Down
23 changes: 0 additions & 23 deletions docs/generate_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,6 @@ set -ex
# Make sure we are in this directory
cd "$(dirname "$0")"

FORCE_BUILD=0

# Check if a -f or --force flag was passed. If yes, then force the build
# of the wheel. Otherwise, check if flatnav exists in the current environment
# If it does, then skip the build process.
if [ "$1" == "-f" ] || [ "$1" == "--force" ]; then
FORCE_BUILD=1
else
if poetry run python -c "import flatnav" &> /dev/null; then
echo "flatnav already installed. Skipping build process"
fi
fi

# Build the wheel file
if [ $FORCE_BUILD -eq 1 ]; then
echo "Forcing the build of the wheel file"
cd ../flatnav_python
./build_wheel.sh
cd ../docs
WHEEL_FILE=$(ls ../flatnav_python/dist/*.whl)
poetry run pip install ${WHEEL_FILE}
fi

# Just another sanity check to make sure every dependency is installed
poetry install

Expand Down
3 changes: 2 additions & 1 deletion docs/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ readme = "README.md"
package-mode = false

[tool.poetry.dependencies]
python = "^3.10"
python = "^3.12"
sphinx = "^7.2.6"
breathe = "^4.35.0"
sphinx-rtd-theme = "^2.0.0"
recommonmark = "^0.7.1"
myst-parser = "^2.0.0"
flatnav = "^0.1.2"


[build-system]
Expand Down

0 comments on commit 06ae33e

Please sign in to comment.