Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 10.6 KB

README.md

File metadata and controls

73 lines (52 loc) · 10.6 KB
Raw

AndroidAPSdocs

Documentation for AndroidAPS

To view documentation, visit https://androidaps.readthedocs.io

Docs Status

Language Build Warning Links
English Documentation Status Build Warnings - en Link Checker - en
German Documentation Status Build Warnings - de Link Checker - de
Dutch Documentation Status Build Warnings - nl Link Checker - nl
Czech Documentation Status Build Warnings - cs Link Checker - cs
Greek Documentation Status Build Warnings - el Link Checker - el
Spanish Documentation Status Build Warnings - es Link Checker - es
Korean Documentation Status Build Warnings - ko Link Checker - ko
Lithuanian Documentation Status Build Warnings - lt Link Checker - lt
Russian Documentation Status Build Warnings - ru Link Checker - ru
Turkish Documentation Status Build Warnings - tr Link Checker - tr
Herbrew Documentation Status Build Warnings - he Link Checker - he

Note: Issues in the source language "English" should be fixed in GitHub. Issues in translation should be fixed via Crowdin platform.

Build and Warning

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, and they can be inspected for more details, by clicking on the status badge or here.

  • 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, and the output can be inspected for more details, or by clicking on the status badge, or here.

  • 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.

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)