diff --git a/.github/workflows/deploy-book.yaml b/.github/workflows/deploy-book.yaml index 7e26e359..a4805253 100644 --- a/.github/workflows/deploy-book.yaml +++ b/.github/workflows/deploy-book.yaml @@ -7,6 +7,7 @@ on: paths: - "docs/**" - ".github/workflows/deploy-book.yaml" + - "README.md" # Allows you to run this workflow manually from the Actions tab workflow_dispatch: diff --git a/docs/src/intro.md b/docs/src/intro.md index 1d93b40f..18886e5e 100644 --- a/docs/src/intro.md +++ b/docs/src/intro.md @@ -1,7 +1,4 @@ -![Altrios Logo](https://raw.githubusercontent.com/NREL/altrios/main/.github/images/ALTRIOS-logo-web.jpg) - -[![homepage](https://img.shields.io/badge/homepage-altrios-blue)](https://www.nrel.gov/transportation/altrios.html) [![Tests](/~https://github.com/NREL/altrios/actions/workflows/tests.yaml/badge.svg)](/~https://github.com/NREL/altrios/actions/workflows/tests.yaml) [![wheels](/~https://github.com/NREL/altrios/actions/workflows/wheels.yaml/badge.svg)](/~https://github.com/NREL/altrios/actions/workflows/wheels.yaml?event=release) [![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10-blue)](https://pypi.org/project/altrios/) [![Documentation](https://img.shields.io/badge/documentation-mdBook-blue.svg)](https://nrel.github.io/altrios/) [![GitHub](https://img.shields.io/badge/GitHub-altrios-blue.svg)](/~https://github.com/NREL/altrios) - -![Model Framework Schematic](https://raw.githubusercontent.com/NREL/altrios/main/.github/images/ALTRIOS_schematic_Alfred_Hicks.png) +{{#include ../../README.md}} This is the overall ALTRIOS documentation. We're working toward making this a fully integrated document that includes both the Python API and Rust core documentation. +