Skip to content

docs: fix stale/broken references and add footer build date #55

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

Closed
petercorke wants to merge 3 commits into from
Closed

docs: fix stale/broken references and add footer build date #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b26e9a
docs: fix stale rank() reference in card-algorithms.rst
petercorke Aug 3, 2026
7968ddf
docs: remove reference to nonexistent CentralCamera.decomposeF
petercorke Aug 3, 2026
a44caa3
docs: add build date to footer copyright notice
petercorke Aug 3, 2026
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
4 changes: 2 additions & 2 deletions docs/source/card-algorithms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ by the toolbox. Consider these as some starting points for exploration.

* Mathematical morphology: :meth:`~machinevisiontoolbox.Image.morph`, :meth:`~machinevisiontoolbox.Image.open`, :meth:`~machinevisiontoolbox.Image.close`, :meth:`~machinevisiontoolbox.Image.dilate`, :meth:`~machinevisiontoolbox.Image.erode`
* Hit or Miss filtering: :meth:`~machinevisiontoolbox.Image.hitormiss`, :meth:`~machinevisiontoolbox.Image.thin`, :meth:`~machinevisiontoolbox.Image.triplepoint`
* Rank filter: :meth:`~machinevisiontoolbox.Image.rank`, :meth:`~machinevisiontoolbox.Image.medianfilter`
* Rank filter: :meth:`~machinevisiontoolbox.Image.rankfilter`, :meth:`~machinevisiontoolbox.Image.medianfilter`
* Distance transform: :meth:`~machinevisiontoolbox.Image.distance_transform`
* Image similarity: :meth:`~machinevisiontoolbox.Image.similarity`

Expand Down Expand Up @@ -69,7 +69,7 @@ by the toolbox. Consider these as some starting points for exploration.
- Camera calibration: :meth:`~machinevisiontoolbox.Camera.CentralCamera.images2C`, :meth:`~machinevisiontoolbox.Camera.CentralCamera.decomposeC`
- Pose estimation: :meth:`machinevisiontoolbox.Camera.CentralCamera.estpose`
- Projection: :meth:`~machinevisiontoolbox.Camera.CentralCamera.project_point`, :meth:`~machinevisiontoolbox.Camera.CentralCamera.project_line`, :meth:`~machinevisiontoolbox.Camera.CentralCamera.project_conic`, :meth:`~machinevisiontoolbox.Camera.CentralCamera.project_quadric`
- Epipolar geometry: :meth:`~machinevisiontoolbox.Camera.CentralCamera.E`, :meth:`~machinevisiontoolbox.Camera.CentralCamera.F`, :meth:`~machinevisiontoolbox.Camera.CentralCamera.epiline`, CentralCamera.decomposeF, :meth:`~machinevisiontoolbox.Camera.CentralCamera.decomposeE`
- Epipolar geometry: :meth:`~machinevisiontoolbox.Camera.CentralCamera.E`, :meth:`~machinevisiontoolbox.Camera.CentralCamera.F`, :meth:`~machinevisiontoolbox.Camera.CentralCamera.epiline`, :meth:`~machinevisiontoolbox.Camera.CentralCamera.decomposeE`
- Homography: :meth:`~machinevisiontoolbox.Camera.CentralCamera.H`
- Fisheye camera: :class:`~machinevisiontoolbox.Camera.FishEyeCamera`
- Catadioptric (omnidirectional) camera: :class:`~machinevisiontoolbox.Camera.CatadioptricCamera`
Expand Down
3 changes: 2 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import datetime
import os
import sys
import inspect
Expand All @@ -28,7 +29,7 @@
# -- Project information -----------------------------------------------------

project = "Machine Vision Toolbox"
copyright = "2020-, Peter Corke"
copyright = f"2020–present, Peter Corke: built {datetime.date.today():%Y-%m-%d}"

Check warning on line 32 in docs/source/conf.py

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/source/conf.py#L32 

Redefining built-in 'copyright'
author = "Peter Corke"

# The full version, including alpha/beta/rc tags
Expand Down