Skip to content

Commit

Permalink
docs: update documentation title and index page layout for better cla…
Browse files Browse the repository at this point in the history
…rity and navigation
  • Loading branch information
yxlao committed Dec 30, 2024
1 parent 5dc3a33 commit 4f8f8e5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@
"dark_logo": "camtools_logo_dark.png",
}

# Set the title with version and git hash
html_title = f"CamTools Documentation ({release})"

# Favicon
favicon_path = (
script_dir.parent / "camtools" / "assets" / "camtools_logo_squre_dark.png"
Expand Down
11 changes: 8 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
CamTools Documentation
======================
.. raw:: html

<div style="height: 1em"></div>

.. only:: not latex

Expand All @@ -19,9 +20,13 @@ CamTools Documentation

<p align="center">
<a href="https://camtools.readthedocs.io/"><strong>Docs</strong></a> |
<a href="https://github.com/yxlao/camtools"><strong>Repo</strong></a>
<a href="https://github.com/yxlao/camtools"><strong>Code</strong></a> |
<a href="https://pypi.org/project/camtools/"><strong>PyPI</strong></a>
</p>

CamTools Documentation
======================

CamTools is a collection of tools for handling cameras in computer vision. It
can be used for plotting, converting, projecting, ray casting, and doing more
with camera parameters. It follows the standard camera coordinate system with
Expand Down

0 comments on commit 4f8f8e5

Please sign in to comment.