Skip to content

Commit

Permalink
Merge pull request #173 from e10harvey/doc_fixes
Browse files Browse the repository at this point in the history
Fix example docs and background width
  • Loading branch information
e10harvey authored Oct 31, 2024
2 parents 90d7e13 + f97a7eb commit b6d0d3e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
5 changes: 5 additions & 0 deletions doc/source/_static/full_width_theme.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.wy-nav-content {
height: 100%;
max-width: 100% !important;
margin: auto;
}
3 changes: 2 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,5 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
html_static_path = ['_static']
html_css_files = ['table_theme.css']
2 changes: 2 additions & 0 deletions example/scene_reconstruction/example_scene_reconstruction.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ def scene_reconstruction(dir_output, dir_input):
The directory where the output files, including point locations and calibration figures, will be saved.
dir_input : str
The directory containing the input files needed for scene reconstruction. This includes:
- 'camera.h5': HDF5 file containing camera parameters.
- 'known_point_locations.csv': CSV file with known point locations.
- 'aruco_marker_images/NAME.JPG': Directory containing images of Aruco markers.
Expand All @@ -29,6 +30,7 @@ def scene_reconstruction(dir_output, dir_input):
Notes
-----
This function performs the following steps:
1. Loads the camera parameters from an HDF5 file.
2. Loads known point locations, point pair distances, and alignment points from CSV files.
3. Initializes the SceneReconstruction object with the camera parameters and known point locations.
Expand Down

0 comments on commit b6d0d3e

Please sign in to comment.