Dont include setting titles in documentation toc

This commit is contained in:
Michael Shepanski 2017-08-20 00:44:14 -04:00
parent 681e1f2ced
commit aaf7a13c0a
4 changed files with 32 additions and 21 deletions

View file

@ -7,3 +7,11 @@
.modname::before { .modname::before {
content: '- '; content: '- ';
} }
.title {
font-weight: bold;
font-size: 1.2em;
background-color: #eee;
display: block;
padding: 1px 5px;
border-left: 2px solid #ddd;
}

View file

@ -1,2 +1,5 @@
.. role:: modname .. role:: modname
:class: modname :class: modname
.. role:: title
:class: title

View file

@ -1,5 +1,5 @@
General Settings :title:`General Settings`
----------------
**butlerUpdateChannel (text)** **butlerUpdateChannel (text)**
Update Channel. (default: 16; choices: 16:Public|8:Plex Pass) Update Channel. (default: 16; choices: 16:Public|8:Plex Pass)
@ -19,8 +19,8 @@ General Settings
Enable Plex Media Server verbose logging. Enable Plex Media Server verbose logging.
Scheduled Task Settings :title:`Scheduled Task Settings`
-----------------------
**butlerDatabaseBackupPath (text)** **butlerDatabaseBackupPath (text)**
Backup directory. The directory in which database backups are stored. (default: /var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Plug-in Support/Databases) Backup directory. The directory in which database backups are stored. (default: /var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Plug-in Support/Databases)
@ -64,8 +64,8 @@ Scheduled Task Settings
Upgrade media analysis during maintenance. (default: True) Upgrade media analysis during maintenance. (default: True)
Channels Settings :title:`Channels Settings`
-----------------
**disableCapabilityChecking (bool)** **disableCapabilityChecking (bool)**
Disable capability checking. Capability checking ensures that plug-ins that are incompatible with this version of the server or the current client application you are using are hidden. Disabling capability checking is useful during development, but will enable access to plug-ins that may perform unreliably with certain client applications. Disable capability checking. Capability checking ensures that plug-ins that are incompatible with this version of the server or the current client application you are using are hidden. Disabling capability checking is useful during development, but will enable access to plug-ins that may perform unreliably with certain client applications.
@ -79,8 +79,8 @@ Channels Settings
Number of seconds to wait before a plugin times out. (default: 180) Number of seconds to wait before a plugin times out. (default: 180)
DLNA Settings :title:`DLNA Settings`
-------------
**dlnaAnnouncementLeaseTime (int)** **dlnaAnnouncementLeaseTime (int)**
DLNA server announcement lease time. Duration in seconds of DLNA Server SSDP announcement lease time. (default: 1800) DLNA server announcement lease time. Duration in seconds of DLNA Server SSDP announcement lease time. (default: 1800)
@ -106,8 +106,8 @@ DLNA Settings
DLNA server timeline reporting. Enable the DLNA server to report timelines for video play activity. (default: True) DLNA server timeline reporting. Enable the DLNA server to report timelines for video play activity. (default: True)
Extras Settings :title:`Extras Settings`
---------------
**cinemaTrailersFromBluRay (bool)** **cinemaTrailersFromBluRay (bool)**
Include Cinema Trailers from new and upcoming movies on Blu-ray. This feature is Plex Pass only. Include Cinema Trailers from new and upcoming movies on Blu-ray. This feature is Plex Pass only.
@ -124,8 +124,8 @@ Extras Settings
Choose Cinema Trailers from. (default: 1; choices: 0:All movies|1:Only unwatched movies) Choose Cinema Trailers from. (default: 1; choices: 0:All movies|1:Only unwatched movies)
Library Settings :title:`Library Settings`
----------------
**allowMediaDeletion (bool)** **allowMediaDeletion (bool)**
Allow media deletion. The owner of the server will be allowed to delete media files from disk. (default: True) Allow media deletion. The owner of the server will be allowed to delete media files from disk. (default: True)
@ -160,8 +160,8 @@ Library Settings
Include music libraries in automatic updates. Linux systems limit the maximum number of watched directories; this may cause problems with large music libraries. Include music libraries in automatic updates. Linux systems limit the maximum number of watched directories; this may cause problems with large music libraries.
Network Settings :title:`Network Settings`
----------------
**allowedNetworks (text)** **allowedNetworks (text)**
List of IP addresses and networks that are allowed without auth. Comma separated list of IP addresses or IP/netmask entries for networks that are allowed to access Plex Media Server without logging in. When the server is signed out and this value is set, only localhost and addresses on this list will be allowed. List of IP addresses and networks that are allowed without auth. Comma separated list of IP addresses or IP/netmask entries for networks that are allowed to access Plex Media Server without logging in. When the server is signed out and this value is set, only localhost and addresses on this list will be allowed.
@ -202,8 +202,8 @@ Network Settings
Webhooks. This feature enables your server to send events to external services. (default: True) Webhooks. This feature enables your server to send events to external services. (default: True)
Transcoder Settings :title:`Transcoder Settings`
-------------------
**hardwareAcceleratedCodecs (bool)** **hardwareAcceleratedCodecs (bool)**
Use hardware acceleration when available (Experimental). Plex Media Server will attempt to use hardware-accelerated video codecs when encoding and decoding video. Hardware acceleration can make transcoding faster and allow more simultaneous video transcodes, but it can also reduce video quality and compatibility. Use hardware acceleration when available (Experimental). Plex Media Server will attempt to use hardware-accelerated video codecs when encoding and decoding video. Hardware acceleration can make transcoding faster and allow more simultaneous video transcodes, but it can also reduce video quality and compatibility.
@ -232,8 +232,8 @@ Transcoder Settings
Transcoder default throttle buffer. Amount in seconds to buffer before throttling the transcoder. (default: 60) Transcoder default throttle buffer. Amount in seconds to buffer before throttling the transcoder. (default: 60)
Misc Settings :title:`Misc Settings`
-------------
**acceptedEULA (bool)** **acceptedEULA (bool)**
Has the user accepted the EULA. Has the user accepted the EULA.
@ -262,8 +262,8 @@ Misc Settings
External network total upload limit (kbps). Speed at which to limit the total bandwidth not on the local network in kilobits per second. Use 0 to set no limit. External network total upload limit (kbps). Speed at which to limit the total bandwidth not on the local network in kilobits per second. Use 0 to set no limit.
Undocumented Settings :title:`Undocumented Settings`
---------------------
* **aBRKeepOldTranscodes (bool)** * **aBRKeepOldTranscodes (bool)**
* **allowHighOutputBitrates (bool)** * **allowHighOutputBitrates (bool)**
* **backgroundQueueIdlePaused (bool)** * **backgroundQueueIdlePaused (bool)**

View file

@ -7,7 +7,7 @@
configuration configuration
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 0
:caption: Modules :caption: Modules
:titlesonly: :titlesonly: