From 17d1ceef07ba33f44225af9c70801afcba0da8d1 Mon Sep 17 00:00:00 2001 From: Alain Nussbaumer Date: Sat, 27 Apr 2024 21:53:01 +0200 Subject: [PATCH] [doc] Add configuration documentation in the menu Moreover, the entries in the menu now match the title of the pages. --- docs/advanced/outputs-alsa.md | 2 +- docs/advanced/outputs-pulse.md | 10 +++++----- docs/advanced/radio-streams.md | 2 +- docs/advanced/remote-access.md | 2 +- docs/clients/cli.md | 2 +- docs/clients/mpd.md | 2 +- docs/configuration.md | 18 +++++++++--------- docs/outputs/streaming.md | 2 +- docs/playlists.md | 2 +- mkdocs.yml | 33 +++++++++++++++++---------------- 10 files changed, 38 insertions(+), 37 deletions(-) diff --git a/docs/advanced/outputs-alsa.md b/docs/advanced/outputs-alsa.md index e38e91cd..c0df5057 100644 --- a/docs/advanced/outputs-alsa.md +++ b/docs/advanced/outputs-alsa.md @@ -1,4 +1,4 @@ -# OwnTone and ALSA +# ALSA ALSA is one of the main output configuration options for local audio; when using ALSA you will typically let the system select the sound card on your machine as the `default` device/sound card - a mixer associated with the ALSA device is used for volume control. However if your machine has multiple sound cards and your system chooses the wrong playback device, you will need to manually select the card and mixer to complete the OwnTone configuration. diff --git a/docs/advanced/outputs-pulse.md b/docs/advanced/outputs-pulse.md index aaf38b3a..fff67023 100644 --- a/docs/advanced/outputs-pulse.md +++ b/docs/advanced/outputs-pulse.md @@ -31,7 +31,7 @@ How to start PulseAudio depends on your distribution, but in many cases you will need to add a `pulseaudio.service` file to `/etc/systemd/system` with the following content: -``` +```conf # systemd service file for PulseAudio running in system mode [Unit] Description=PulseAudio sound server @@ -49,7 +49,7 @@ Bluetooth module. First install it (Debian: `apt install pulseaudio-module-bluetooth`) and then add the following to /etc/pulse/system.pa: -``` +```conf #### Enable Bluetooth .ifexists module-bluetooth-discover.so load-module module-bluetooth-discover @@ -117,7 +117,7 @@ Edit the file `~/.pulse/default.pa` , adding the following line at the end: load-module module-native-protocol-tcp auth-ip-acl=127.0.0.1 ``` -### Step 3: Restart the pulseaudio deamon +### Step 3: Restart the PulseAudio daemon ```shell pulseaudio -k @@ -125,11 +125,11 @@ pulseaudio -k pulseaudio -D ``` -### Step 4: Adjust configuration file +### Step 4: Adjust the Configuration File In the `audio` section of `/etc/owntone.conf`, set `server` to `localhost`: -``` +```conf server = "localhost" ``` diff --git a/docs/advanced/radio-streams.md b/docs/advanced/radio-streams.md index 0e4e0341..3f80e87d 100644 --- a/docs/advanced/radio-streams.md +++ b/docs/advanced/radio-streams.md @@ -1,4 +1,4 @@ -# Radio Stream Tweaking +# Radio Streams Radio streams have many different ways in how metadata is sent. Many should just work as expected, but a few may require some tweaking. If you are not diff --git a/docs/advanced/remote-access.md b/docs/advanced/remote-access.md index c39ddf18..ba31fd91 100644 --- a/docs/advanced/remote-access.md +++ b/docs/advanced/remote-access.md @@ -1,4 +1,4 @@ -# Remote access +# Remote Access It is possible to access a shared library over the internet from a DAAP client like iTunes. You must have remote access to the host machine. diff --git a/docs/clients/cli.md b/docs/clients/cli.md index 98bba3e4..07e746b7 100644 --- a/docs/clients/cli.md +++ b/docs/clients/cli.md @@ -1,4 +1,4 @@ -# Command line +# Command Line You can choose between: diff --git a/docs/clients/mpd.md b/docs/clients/mpd.md index 7be476aa..207e6016 100644 --- a/docs/clients/mpd.md +++ b/docs/clients/mpd.md @@ -1,4 +1,4 @@ -# MPD clients +# MPD Clients You can - to some extent - use clients for MPD to control OwnTone. diff --git a/docs/configuration.md b/docs/configuration.md index 86d9a925..a3bed8bb 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -7,8 +7,8 @@ The configuration of OwnTone - usually located in `/etc/owntone.conf` - is split - [`audio`](#local-audio-settings) - Settings for the local audio. - [`alsa`](#per-alsa-device-settings) - Settings for ALSA devices. - [`fifo`](#fifo-settings) - Settings for named pipe. -- [`airplay_shared`](#shared-airplay-settings) - Settings shared across Airplay devices. -- [`airplay`](#per-airplay-device-settings) - Settings for a specific Airplay device. +- [`airplay_shared`](#shared-airplay-settings) - Settings shared across AirPlay devices. +- [`airplay`](#per-airplay-device-settings) - Settings for a specific AirPlay device. - [`chromecast`](#per-chromecast-device-settings) - Settings for a specific Chromecast device. - [`spotify`](#spotify-settings) - Settings for the Spotify playback. - [`rcp`](#rcp--roku-soundbridge-settings) - Settings for RCP / Roku Soundbridge devices. @@ -740,7 +740,7 @@ The `audio` section is meant to configure the local audio output. It accepts the mixer_device = "" ``` -- `sync_disable` - Flag to indicate whether or not audio resampling has to be enabled to keep local audio in sync with, for example, Airplay. +- `sync_disable` - Flag to indicate whether or not audio resampling has to be enabled to keep local audio in sync with, for example, AirPlay. **Note:** This feature relies on accurate ALSA measurements of delay, and some devices don't provide that. If that is the case you are better off disabling the feature. @@ -750,7 +750,7 @@ The `audio` section is meant to configure the local audio output. It accepts the sync_disable = ``` -- `offset_ms` - Start delay in milliseconds relatively to other speakers, for example Airplay. +- `offset_ms` - Start delay in milliseconds relatively to other speakers, for example AirPlay. **Note:** Negative values correspond to moving local audio ahead, positive correspond to delaying it. @@ -808,7 +808,7 @@ Each `alsa` section is meant to configure a named ALSA output: one named section mixer_device = "" ``` -- `offset_ms` - Start delay in milliseconds relatively to other speakers, for example Airplay. +- `offset_ms` - Start delay in milliseconds relatively to other speakers, for example AirPlay. **Note:** Negative values correspond to moving local audio ahead, positive correspond to delaying it. @@ -856,7 +856,7 @@ airplay_shared { The `airplay_shared` section describes the settings that are shared across all the AirPlay devices. -- `control_port` - Number of the UDP control port used when Airplay devices make connections back to OwnTone. +- `control_port` - Number of the UDP control port used when AirPlay devices make connections back to OwnTone. **Note:** Choosing specific ports may be helpful when running OwnTone behind a firewall. @@ -866,7 +866,7 @@ The `airplay_shared` section describes the settings that are shared across all t control_port = 0 ``` -- `timing_port` - Number of the UDP timing port used when Airplay devices make connections back to OwnTone. +- `timing_port` - Number of the UDP timing port used when AirPlay devices make connections back to OwnTone. **Note:** Choosing specific ports may be helpful when running OwnTone behind a firewall. @@ -876,7 +876,7 @@ The `airplay_shared` section describes the settings that are shared across all t timing_port = 0 ``` -- `uncompressed_alac` - Switch Airplay 1 streams to uncompressed ALAC (as opposed to regular, compressed ALAC). Reduces CPU use at the cost of network bandwidth. +- `uncompressed_alac` - Switch AirPlay 1 streams to uncompressed ALAC (as opposed to regular, compressed ALAC). Reduces CPU use at the cost of network bandwidth. **Default:** `false` @@ -892,7 +892,7 @@ airplay "" { } ``` -Each `airplay` section is meant to configure a named Airplay output: one named section per device. It accepts the settings below. +Each `airplay` section is meant to configure a named AirPlay output: one named section per device. It accepts the settings below. **Note:** The capitalisation of the device name is relevant. diff --git a/docs/outputs/streaming.md b/docs/outputs/streaming.md index 2a17e9a1..5e83b68e 100644 --- a/docs/outputs/streaming.md +++ b/docs/outputs/streaming.md @@ -1,4 +1,4 @@ -# MP3 network streaming (streaming to iOS) +# Streaming You can listen to audio being played by OwnTone by opening this network stream address in pretty much any music player: diff --git a/docs/playlists.md b/docs/playlists.md index ba1cbdcd..f736bb23 100644 --- a/docs/playlists.md +++ b/docs/playlists.md @@ -1,4 +1,4 @@ -# Playlists and internet radio +# Playlists and Radio OwnTone supports M3U and PLS playlists. Just drop your playlist somewhere in your library with an .m3u or .pls extension and it will pick it up. diff --git a/mkdocs.yml b/mkdocs.yml index 9fd7d957..a5a28ce2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -127,31 +127,32 @@ markdown_extensions: nav: - Home: index.md - Documentation: - - Getting started: getting-started.md + - Getting Started: getting-started.md - Installation: installation.md + - Configuration: configuration.md - Building: building.md - Library: library.md - Artwork: artwork.md - - Playlists & radio: playlists.md - - Smart playlists: smart-playlists.md + - Playlists and Radio: playlists.md + - Smart Playlists: smart-playlists.md - Clients: - - Supported clients: clients/supported-clients.md + - Supported Clients: clients/supported-clients.md - Remote: clients/remote.md - - Web interface: clients/web-interface.md - - MPD clients: clients/mpd.md - - CLI: clients/cli.md + - Web Interface: clients/web-interface.md + - MPD Clients: clients/mpd.md + - Command Line: clients/cli.md - Outputs: - - Local audio: outputs/local-audio.md - - Airplay: outputs/airplay.md + - Local Audio: outputs/local-audio.md + - AirPlay: outputs/airplay.md - Chromecast: outputs/chromecast.md - Streaming: outputs/streaming.md - - Services integration: + - Services Integration: - Spotify: integrations/spotify.md - LastFM: integrations/lastfm.md - - Advanced setups: - - Alsa: advanced/outputs-alsa.md - - Pulse audio: advanced/outputs-pulse.md - - Radio streams: advanced/radio-streams.md - - Remote access: advanced/remote-access.md - - Multiple instances: advanced/multiple-instances.md + - Advanced Setup: + - ALSA: advanced/outputs-alsa.md + - PulseAudio: advanced/outputs-pulse.md + - Radio Streams: advanced/radio-streams.md + - Remote Access: advanced/remote-access.md + - Multiple Instances: advanced/multiple-instances.md - JSON API: json-api.md