From 51f4078aed857bb3c0385ecf11e68e9e61eb233b Mon Sep 17 00:00:00 2001 From: Ross Stewart Date: Fri, 29 Aug 2025 16:24:54 +0000 Subject: [PATCH] Documentation update --- docs/_sources/index.rst | 15 +++++++++----- docs/index.html | 45 ++++++++++++++++++++++++++++------------- docs/searchindex.js | 2 +- 3 files changed, 42 insertions(+), 20 deletions(-) diff --git a/docs/_sources/index.rst b/docs/_sources/index.rst index dbca69f..758f324 100644 --- a/docs/_sources/index.rst +++ b/docs/_sources/index.rst @@ -456,9 +456,10 @@ You can enable the following debug options by setting the NAVI_DEBUG environment will be **publicly** available while this is enabled. Known Issues ------------- +************ -#. The skill appears to work but no music is played. Errors similar to below appear in the web service log +The skill appears to work but no music is played. Errors similar to below appear in the web service log +-------------------------------------------------------------------------------------------------------- .. code-block:: bash @@ -471,7 +472,9 @@ Known Issues * I have not found a reason as to why this happens from time to time, however it can be resolved by doing a hard reboot of your Echo device. Disconnect the power for a minute and plug it back in then try again and music should play -#. The following error is displayed when you try to run the Docker container +The following error is displayed when you try to run the Docker container +------------------------------------------------------------------------- + .. code-block:: bash @@ -480,7 +483,9 @@ Known Issues * You are using the prebuilt container on a non amd64 based system. You will need to build your own Docker image using the Dockerfile included with the repository. -#. You are having trouble connecting to the skill and use CloudFlare +You are having trouble connecting to the skill and use CloudFlare +----------------------------------------------------------------- + .. NOTE:: Thanks to @dwebb8272 and @jame25 @@ -512,7 +517,7 @@ Code Documentation ****************** .. toctree:: - :maxdepth: 2 + :maxdepth: 4 :caption: Contents: AskNavidrome main diff --git a/docs/index.html b/docs/index.html index 33cd9f7..7b7499a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -332,7 +332,12 @@ document.write(`
  • Troubleshooting +
  • +
  • Known Issues
  • Code Documentation +
    -

    Known Issues#

    -
      -
    1. The skill appears to work but no music is played. Errors similar to below appear in the web service log

      -
      2022-11-19 13:16:45,478 - root - DEBUG - In PlaybackFailedHandler
      +

      Known Issues#

      +
      +

      The skill appears to work but no music is played. Errors similar to below appear in the web service log#

      +
      +
      2022-11-19 13:16:45,478 - root - DEBUG - In PlaybackFailedHandler
       2022-11-19 13:16:45,479 - root - ERROR - Playback Failed: {'message': 'Device playback error', 'object_type': 'MEDIA_ERROR_UNKNOWN'}
       2022-11-19 13:16:45,480 - werkzeug - INFO - 10.44.17.62 - - [19/Nov/2022 13:16:45] "POST / HTTP/1.1" 200 -
       2022-11-19 13:16:48,599 - root - DEBUG - In PlaybackFailedHandler
      @@ -906,18 +913,24 @@ will be publicly available while this is enabled.

    2. I have not found a reason as to why this happens from time to time, however it can be resolved by doing a hard reboot of your Echo device. Disconnect the power for a minute and plug it back in then try again and music should play

    3. - -
    4. The following error is displayed when you try to run the Docker container

      -
      exec /opt/env/bin/python3: exec format error
      +
      +
    +
    +

    The following error is displayed when you try to run the Docker container#

    +
    +
    exec /opt/env/bin/python3: exec format error
     
    • You are using the prebuilt container on a non amd64 based system. You will need to build your own Docker image using the Dockerfile included with the repository.

    -
  • -
  • You are having trouble connecting to the skill and use CloudFlare

    -
    +
    + +
    +

    You are having trouble connecting to the skill and use CloudFlare#

    +
    +

    Note

    Thanks to @dwebb8272 and @jame25

    @@ -933,8 +946,7 @@ to debug.

    Once you have the rule in place disable proxying for your AskNavidrome web service domain in CloudFlare by navigating to DNS -> Records and setting it to DNS Only.

    -
  • - +
    @@ -1716,7 +1728,12 @@ is working

  • Troubleshooting +
  • +
  • Known Issues
  • Code Documentation