-
Notifications
You must be signed in to change notification settings - Fork 325
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2216 from emilisev/delete-third-party-automation
Delete third party automation, update Readme
- Loading branch information
Showing
192 changed files
with
14 additions
and
44,999 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,17 @@ | ||
| # AndroidAPSdocs | ||
| # AAPS docs | ||
|
|
||
| Documentation for [AndroidAPS](https://github.com/nightscout/AndroidAPS) | ||
| Documentation for [AAPS](https://github.com/nightscout/AndroidAPS) (Android Artificial Pancreas System). | ||
|
|
||
| To view documentation, visit <https://androidaps.readthedocs.io> | ||
| To view documentation, visit <https://androidaps.readthedocs.io>. | ||
|
|
||
| ## Docs Status | ||
|
|
||
| | Language | Build | Warning | Links | | ||
| | -------- | ----- | ------- | ----- | | ||
| | [English](https://androidaps.readthedocs.io/en/latest/) | [](https://readthedocs.org/projects/androidaps/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [German](https://androidaps.readthedocs.io/de/latest/) | [](https://readthedocs.org/projects/androidaps-de/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [Dutch](https://androidaps.readthedocs.io/nl/latest/) | [](https://readthedocs.org/projects/androidaps-nl/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [Czech](https://androidaps.readthedocs.io/cs/latest/) | [](https://readthedocs.org/projects/androidaps-cs/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [Greek](https://androidaps.readthedocs.io/el/latest/) | [](https://readthedocs.org/projects/androidaps-el/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [Spanish](https://androidaps.readthedocs.io/es/latest/) | [](https://readthedocs.org/projects/androidaps-es/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [Korean](https://androidaps.readthedocs.io/ko/latest/) | [](https://readthedocs.org/projects/androidaps-ko/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [Lithuanian](https://androidaps.readthedocs.io/lt/latest/) | [](https://readthedocs.org/projects/androidaps-lt/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [Russian](https://androidaps.readthedocs.io/ru/latest/) | [](https://readthedocs.org/projects/androidaps-ru/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [Turkish](https://androidaps.readthedocs.io/tr/latest/) | [](https://readthedocs.org/projects/androidaps-tr/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| | [Herbrew](https://androidaps.readthedocs.io/he/latest/) | [](https://readthedocs.org/projects/androidaps-he/builds/) | [](../../actions?query=workflow%3A%22Build+Warnings%22) | [](../../actions?query=workflow%3A%22Link+Checker%22) | | ||
| [](https://github.com/openaps/AndroidAPSdocs/actions/workflows/deploy.yml)  | ||
|
|
||
| ### Build and Warnings | ||
|
|
||
| **Note:** Issues in the source language "English" should be fixed in [GitHub](https://github.com/openaps/AndroidAPSdocs). Issues in translation should be fixed via [Crowdin](https://crowdin.com/project/androidapsdocs) platform. | ||
| The current build logs of the documentation can be found in [Github Actions](https://github.com/openaps/AndroidAPSdocs/actions/workflows/deploy.yml). | ||
|
|
||
| ### Build and Warning | ||
| ### Broken links | ||
|
|
||
| The current build logs of the documentation can be found on the documentation hosting site, by clicking the **docs** badge in the column **Build**. | ||
|
|
||
| For the selected project on readthedocs.org, the **Builds** section will be opened. | ||
| Select the top entry "**Passed** version latest (html)" and select **View raw** or click at the bottom grey bar */home/docs/checkouts/readthedocs.org/user_builds/androidaps...* to expand the build logs. | ||
|
|
||
| The badges are generated with a [GitHub Action](../../actions), and they can be inspected for more details, by clicking on the status badge or [here](../../actions/workflows/build-warnings.yml). | ||
|
|
||
| * Select the top workflow **Build warning** | ||
| * Select the build of a language, for example **build (de)** | ||
| * Click on the section **Build docs** to see the build output | ||
|
|
||
| ### Broken Links | ||
|
|
||
| The badges are generated with a [GitHub Action](../../actions), and the output can be inspected for more details, or by clicking on the status badge, or [here](../../actions/workflows/link-checker.yml). | ||
|
|
||
| * Select the top workflow **Link Checker** | ||
| * Select the build of a language, for example **check (de)** | ||
| * Click on the section **Link Checker** to see the link checker output | ||
|
|
||
| **Note:** Links that always failed, but are working correctly should be excluded in the check. Please raise an issue, on one of the channels, or open a pull request in the [flow](https://github.com/openaps/AndroidAPSdocs/.github/workflows/link-checker.yml#L56). | ||
|
|
||
| ### Most common issues | ||
|
|
||
| The most issues are in restructured text: | ||
|
|
||
| - Title underline are too short; they should be at least as long as the title | ||
| - Missing new line, after list | ||
| - links are broken, OK `` `Link text <link URL>`_`` | ||
| - Replaced back quote \` by another type of quote: `` 'Link text <link URL>"_`` | ||
| - Missing space before < link `` `Linktext<link URL>`_`` | ||
| - Extra space after > link `` `Linktext <link URL> `_`` | ||
| - Extra space after \` back tick `` `Linktext <link URL>` _`` | ||
| - Closing italic or bold text is not done, or a space is added before or after | ||
| - OK `**My bold text**` | ||
| - Not OK `** My broken bold text **` | ||
| - Markdown syntax is used in rst files, they are not compatible. | ||
| - Directive are translated, https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html | ||
|
|
||
| ### Link issues | ||
|
|
||
| The link checker validates both internal and external links. Most common issues: | ||
|
|
||
| - Translation headers, cause link anchor form other pages to be broken | ||
| - External links are changed | ||
| - Link checker receives a redirect on external page | ||
| - Link anchor to was generated on page load (have to be excluded) | ||
| Detail of broken links in the doc can be found in the build logs. Select a build in Github Action "Deploy", then "Usage". Click on "build" and expand again the "Build line". Search for "WARNING". |
Oops, something went wrong.