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

Restore Docs build and fixes #999

Merged
merged 2 commits into from
Jan 22, 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
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ jobs:
fail-fast: false
matrix:
version:
- '1.9'
- '1.10'
os:
- ubuntu-latest
arch:
Expand Down Expand Up @@ -109,7 +109,7 @@ jobs:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: 1.10
version: '1.10'
arch: x64
- uses: actions/cache@v1
env:
Expand Down Expand Up @@ -147,7 +147,7 @@ jobs:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: 1.10
version: '1.10'
- name: 'Docs on ${{ github.head_ref }}'
run: |
export JULIA_PKG_SERVER=""
Expand Down
2 changes: 2 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ using RoME
using Colors
using Images

import Caesar._PCL as _PCL

import IncrementalInference: fmcmc!, localProduct, prodmultiplefullpartials, prodmultipleonefullpartials, setfreeze!
import IncrementalInference: cliqGibbs, packFromLocalPotentials!, treeProductDwn, updateFGBT!, upGibbsCliqueDensity
import IncrementalInference: initfg, downGibbsCliqueDensity
Expand Down
28 changes: 14 additions & 14 deletions docs/src/examples/using_pcl.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
## Introduction `Caesar._PCL`

A wide ranging and well used [point cloud library exists called PCL](https://pointclouds.org/) which is implemented in C++. To get access to many of those features and bridge the Caesar.jl suite of packages, the base `PCL.PointCloud` types have been implemented in Julia and reside under `Caesar._PCL`. The main types of interest:
- [`Caesar._PCL.PointCloud`](@ref),
- [`Caesar._PCL.PCLPointCloud2`](@ref),
- [`Caesar._PCL.PointXYZ`](@ref),
- [`Caesar._PCL.Header`](@ref),
- [`Caesar._PCL.PointField`](@ref),
- [`Caesar._PCL.FieldMapper`](@ref).

These types are conditionally loaded once `Colors.jl` is included (see [Requires.jl](https://github.com/JuliaPackaging/Requires.jl)),
- `Caesar._PCL.PointCloud`
- `Caesar._PCL.PCLPointCloud2`
- `Caesar._PCL.PointXYZ`
- `Caesar._PCL.Header`
- `Caesar._PCL.PointField`
- `Caesar._PCL.FieldMapper`

The PointCloud types use `Colors.jl`:
```julia
using Colors, Caesar
using StaticArrays
Expand All @@ -23,7 +23,7 @@ pt = Caesar._PCL.PointXYZ(;data=SA[x,y,z,intens])
```

```@docs
Caesar._PCL.PointCloud
_PCL.PointCloud
```

## Conversion with `ROS.PointCloud2`
Expand All @@ -34,11 +34,11 @@ Strong integration between PCL and [ROS](http://www.ros.org) predominantly throu
These have been integrated through conversions to equivalent Julian types already listed above. ROS conversions requires RobotOS.jl be loaded, see page on using [ROS Direct](@ref ros_direct).

```@docs
Caesar._PCL.PCLPointCloud2
Caesar._PCL.PointXYZ
Caesar._PCL.Header
Caesar._PCL.PointField
Caesar._PCL.FieldMapper
_PCL.PCLPointCloud2
_PCL.PointXYZ
_PCL.Header
_PCL.PointField
_PCL.FieldMapper
```

## Aligning Point Clouds
Expand Down
Loading