diff --git a/doc/overrides/outdated.html b/doc/overrides/outdated.html new file mode 100644 index 0000000..35591d6 --- /dev/null +++ b/doc/overrides/outdated.html @@ -0,0 +1,8 @@ +{% extends "base.html" %} + +{% block outdated %} + You're not viewing the latest version. + + Click here to go to latest. + +{% endblock %} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a82ea34..26ec218 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 diff --git a/pyproject.toml b/pyproject.toml index d0fbe4a..e9b3b85 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,6 +23,7 @@ dev = [ "codecov", "ruff", "mkdocs-material", + "mike", "amaranth_boards@git+https://github.com/amaranth-lang/amaranth-boards" ] diff --git a/src/manta/cli.py b/src/manta/cli.py index ba27572..9407fd2 100644 --- a/src/manta/cli.py +++ b/src/manta/cli.py @@ -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 """