docs: add mike

This commit is contained in:
Fischer Moseley 2024-10-06 10:52:23 -06:00
parent 19342c4735
commit 1f8bf643fd
4 changed files with 16 additions and 1 deletions

View File

@ -0,0 +1,8 @@
{% extends "base.html" %}
{% block outdated %}
You're not viewing the latest version.
<a href="{{ '../' ~ base_url }}">
<strong>Click here to go to latest.</strong>
</a>
{% endblock %}

View File

@ -1,6 +1,7 @@
site_name: "Manta Documentation"
site_description: Manta Documentation
site_author: Fischer Moseley
site_url: https://fischermoseley.github.io/manta/
repo_url: https://github.com/fischermoseley/manta/
repo_name: fischermoseley/manta
@ -10,6 +11,7 @@ theme:
name: material
logo: assets/logo_minimal_border.png
favicon: assets/logo_ray_only_with_shadow.png
custom_dir: doc/overrides/
features:
- content.code.copy
- content.code.annotate
@ -60,6 +62,10 @@ markdown_extensions:
- pymdownx.tilde
- attr_list
extra:
version:
provider: mike
nav:
- Home: index.md
- Installation: installation.md

View File

@ -23,6 +23,7 @@ dev = [
"codecov",
"ruff",
"mkdocs-material",
"mike",
"amaranth_boards@git+https://github.com/amaranth-lang/amaranth-boards"
]

View File

@ -25,7 +25,7 @@ logo = f"""
`------........------'
Manta - An In-Situ Debugging Tool for Programmable Hardware
Manta - A configurable and approachable tool for FPGA debugging and rapid prototyping
Version {distribution("manta").version}
https://github.com/fischermoseley/manta
"""