Skip to content

Commit dca810e

Browse files
Add docs references to README.md and bump project to 1.2.2 (#40)
* Add documentation references to `README.md` - Add status badge linking to the `docs.yml` workflow. - Add a documentation link in the introduction section pointing to the project's GitHub Pages site. This ensures the documentation is correctly referenced in the `README.md` file and is easily accessible from external sites like PyPI. * Bump project to `1.2.2`
1 parent cae9d7a commit dca810e

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
<div align="center">
44

55
[![PyPi](https://img.shields.io/pypi/v/direct-data-driven-mpc)](https://pypi.org/project/direct-data-driven-mpc)
6-
[![GitHub Actions status](https://github.com/pavelacamposp/direct-data-driven-mpc/actions/workflows/ci_workflow.yml/badge.svg)](https://github.com/pavelacamposp/direct-data-driven-mpc/actions/workflows/ci_workflow.yml)
6+
[![CI Workflow status](https://github.com/pavelacamposp/direct-data-driven-mpc/actions/workflows/ci_workflow.yml/badge.svg)](https://github.com/pavelacamposp/direct-data-driven-mpc/actions/workflows/ci_workflow.yml)
7+
[![Docs status](https://img.shields.io/github/actions/workflow/status/pavelacamposp/direct-data-driven-mpc/docs.yml?label=docs&color=brightgreen)](https://github.com/pavelacamposp/direct-data-driven-mpc/actions/workflows/docs.yml)
78
[![codecov](https://codecov.io/gh/pavelacamposp/direct-data-driven-mpc/graph/badge.svg)](https://codecov.io/gh/pavelacamposp/direct-data-driven-mpc)
89
[![Ruff](https://img.shields.io/badge/Lint%20%26%20Format-Ruff-blue?logo=ruff&logoColor=white)](https://github.com/astral-sh/ruff)
910
[![Python](https://img.shields.io/badge/Python-3.10%20|%203.12-blue)](https://docs.python.org/3.10)
@@ -30,6 +31,8 @@ This repository provides a Python implementation of Direct Data-Driven Model Pre
3031

3132
A **direct data-driven controller** maps measured input-output data from an unknown system *directly* onto the controller without requiring an explicit system identification step. This approach is particularly useful in applications where the system dynamics are too complex to be modeled accurately or where traditional system identification methods are impractical or difficult to apply.
3233

34+
📖 View the full project documentation on our **[documentation page](https://pavelacamposp.github.io/direct-data-driven-mpc)**.
35+
3336
---
3437
***Disclaimer:** This is an independent project based on the referenced papers and does not contain the official implementations from the authors.*
3538

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "direct-data-driven-mpc"
7-
version = "1.2.1"
7+
version = "1.2.2"
88
authors = [
99
{ name = "Pável A. Campos-Peña", email = "pcamposp@uni.pe" }
1010
]

0 commit comments

Comments
 (0)