From 55b0af3896f0d00523cdbe1db54b35313234a5d4 Mon Sep 17 00:00:00 2001 From: Chad Baker Date: Wed, 24 Jan 2024 19:52:41 -0700 Subject: [PATCH 1/2] seems to be working with readme in mdbook --- .github/workflows/deploy-book.yaml | 1 + docs/src/intro.md | 3 +++ 2 files changed, 4 insertions(+) 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..7f4b5a5a 100644 --- a/docs/src/intro.md +++ b/docs/src/intro.md @@ -1,3 +1,5 @@ +{{#include ../../README.md}} + ![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) @@ -5,3 +7,4 @@ ![Model Framework Schematic](https://raw.githubusercontent.com/NREL/altrios/main/.github/images/ALTRIOS_schematic_Alfred_Hicks.png) 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. + From f413f85c3366c003a1657a32c9b3aba693747806 Mon Sep 17 00:00:00 2001 From: Chad Baker Date: Thu, 25 Jan 2024 09:06:49 -0700 Subject: [PATCH 2/2] removed things that are already covered in README.md --- docs/src/intro.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/src/intro.md b/docs/src/intro.md index 7f4b5a5a..18886e5e 100644 --- a/docs/src/intro.md +++ b/docs/src/intro.md @@ -1,10 +1,4 @@ {{#include ../../README.md}} -![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) - 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.