From cb3788f7fb73507350847f93b8754c12efd15e8a Mon Sep 17 00:00:00 2001 From: Jonas Huber Date: Sun, 17 Nov 2024 16:40:29 +0100 Subject: [PATCH 1/4] fix rest-api documentation link --- oeplatform/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/oeplatform/settings.py b/oeplatform/settings.py index 0ec47d82c..dcd24c22f 100644 --- a/oeplatform/settings.py +++ b/oeplatform/settings.py @@ -90,7 +90,7 @@ "tutorials_wizard": "https://openenergyplatform.github.io/academy/tutorials/99_other/wizard/", # noqa E501 "tutorials_create_database_conform_data": "https://openenergyplatform.github.io/academy/tutorials/99_other/database_data/", # noqa E501 "tutorials_oemetadata": "https://openenergyplatform.github.io/academy/tutorials/99_other/getting_started_with_OEMetadata/", # noqa E501 - "readthedocs": "https://oeplatform.readthedocs.io/en/latest/?badge=latest", + "readthedocs": "https://openenergyplatform.github.io/oeplatform/oeplatform-code/web-api/oedb-rest-api/", "mkdocs": "https://openenergyplatform.github.io/oeplatform/", "compendium": "https://openenergyplatform.github.io/organisation/", "tib_terminology_service": "https://terminology.tib.eu/ts/collections", From 2f99b5eb5cb8fe74dec9d24fc8c28f845a4a5b68 Mon Sep 17 00:00:00 2001 From: Jonas Huber Date: Sun, 17 Nov 2024 16:40:54 +0100 Subject: [PATCH 2/4] fix link to next steps as anchor name changed --- docs/installation/guides/manual-db-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/guides/manual-db-setup.md b/docs/installation/guides/manual-db-setup.md index bdbdeaeab..598906ee5 100644 --- a/docs/installation/guides/manual-db-setup.md +++ b/docs/installation/guides/manual-db-setup.md @@ -252,6 +252,6 @@ dbname = os.environ.get("LOCAL_DB_NAME", "oedb") ## 4 Create the database tables -To complete the database installation, the table structures must then be installed. [Step 3](./installation.md#3-setup-the-openenergyontology-integation) & [Step 4](./installation.md#4-loading-and-compressing-static-assets-from-the-oeplattform-applications) must be completed first so that the necessary commands can be executed after. +To complete the database installation, the table structures must then be installed. [Step 3](./installation.md#3-setup-the-openenergyontology-integration) & [Step 4](./installation.md#4-loading-and-compressing-static-assets-from-the-oeplattform-applications) must be completed first so that the necessary commands can be executed after. After that Proceed with the next steps in section [4.2 Create the database table structures](installation.md#32-create-the-database-table-structures) of the oeplatform installation guide. From 57f29f42867f252437912e3eaaeca4d31f420427 Mon Sep 17 00:00:00 2001 From: Jonas Huber Date: Sun, 17 Nov 2024 16:42:05 +0100 Subject: [PATCH 3/4] fix info boxes --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index cceae65d8..bcb2386b5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,10 +7,10 @@ title: Home Welcome to the Open Energy Platform Documentation. This site provides the developer documentation for the Open Energy Platform (OEP). !!! Info "State of the documentation" -The documentation already provides helpful information but is not yet complete. As only parts of it were maintained during the long-term development, we have to catch up. This is a task that we cannot complete in one go. We have therefore decided to complete it step by step. This means that we will update the documentation of the missing code as soon as we have to work on the corresponding code again. Documentation for the Community area will be added continuously and in a timely manner. + The documentation already provides helpful information but is not yet complete. As only parts of it were maintained during the long-term development, we have to catch up. This is a task that we cannot complete in one go. We have therefore decided to complete it step by step. This means that we will update the documentation of the missing code as soon as we have to work on the corresponding code again. Documentation for the Community area will be added continuously and in a timely manner. !!! Info "Compendium" -If you want to get an overview about the complete Open Energy Family Framework please have a look at our [Compendium](https://openenergyplatform.github.io/organisation/). + If you want to get an overview about the complete Open Energy Family Framework please have a look at our [Compendium](https://openenergyplatform.github.io/organisation/). ## Structure of the documentation From 813d7f462ac0dbaa52db15c794fd584b9a3c5eca Mon Sep 17 00:00:00 2001 From: Jonas Huber Date: Sun, 17 Nov 2024 16:45:51 +0100 Subject: [PATCH 4/4] update changelog --- versions/changelogs/current.md | 1 + 1 file changed, 1 insertion(+) diff --git a/versions/changelogs/current.md b/versions/changelogs/current.md index 6a46196bc..fa02e6626 100644 --- a/versions/changelogs/current.md +++ b/versions/changelogs/current.md @@ -24,3 +24,4 @@ - Added documentation for Design System and Accessibility [(#1716)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1716) - Restructure documentation layout & enhance content [(#1905)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1905) +- Fix link to rest-api documentation on mkdocs and update text formatting on the documentation main page. [(#1907)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1907)