izackp/Apollo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update admonitions

Browse Source
This commit is contained in:
ReenigneArcher
2022-04-18 16:05:17 -04:00
parent 293ee266af
commit 56cf3e4ede
8 changed files with 17 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/about/advanced_usage.rst
View File

@@ -29,7 +29,7 @@ Example
To manually configure sunshine you may edit the `conf` file in a text editor. Use the examples as reference. To manually configure sunshine you may edit the `conf` file in a text editor. Use the examples as reference.
.. Note:: Some settings are not available within the web ui. .. Hint:: Some settings are not available within the web ui.
General General
------- -------
@@ -166,7 +166,7 @@ Description
.. Tip:: See `virtual key codes <https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes>`_ .. Tip:: See `virtual key codes <https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes>`_
.. Note:: keybindings needs to have a multiple of two elements. .. Hint:: keybindings needs to have a multiple of two elements.
Default Default
None None

2
docs/source/about/installation.rst
View File

@@ -45,7 +45,7 @@ Red Hat Packages
#. Download the corresponding `.rpm` file, e.g. ``sunshine-fedora_35.rpm`` #. Download the corresponding `.rpm` file, e.g. ``sunshine-fedora_35.rpm``
#. ``sudo rpm -i <downloaded rpm file>``, e.g. ``sudo rpm -i ./sunshine-fedora_35.rpm`` #. ``sudo rpm -i <downloaded rpm file>``, e.g. ``sudo rpm -i ./sunshine-fedora_35.rpm``
.. Note:: If this is the first time installing. .. Hint:: If this is the first time installing.
.. code-block:: bash .. code-block:: bash

4
docs/source/about/third_party_packages.rst
View File

@@ -3,7 +3,7 @@
Third Party Packages Third Party Packages
==================== ====================
.. Warning:: These packages are not maintained by SunshineStream. Use at your own risk. .. Danger:: These packages are not maintained by SunshineStream. Use at your own risk.
AUR (Arch Linux User Repository) AUR (Arch Linux User Repository)
-------------------------------- --------------------------------
@@ -51,6 +51,8 @@ Scoop
Legacy GitHub Repo Legacy GitHub Repo
------------------ ------------------
.. Attention:: This repo is no longer maintained. Thank you to Loki for bringing this amazing project to life!
.. image:: https://img.shields.io/github/last-commit/loki-47-6F-64/sunshine?style=for-the-badge&logo=github .. image:: https://img.shields.io/github/last-commit/loki-47-6F-64/sunshine?style=for-the-badge&logo=github
:alt: GitHub last commit :alt: GitHub last commit

10
docs/source/about/usage.rst
View File

@@ -5,7 +5,9 @@ Usage
#. See the `setup`_ section for your specific OS. #. See the `setup`_ section for your specific OS.
#. Run ``sunshine <directory of conf file>/sunshine.conf``. #. Run ``sunshine <directory of conf file>/sunshine.conf``.
.. Note:: The configuration file specified will be created if it doesn't exist. .. Note:: You do not need to specify a config file. If no config file is entered the default location will be used.
.. Attention:: The configuration file specified will be created if it doesn't exist.
.. Tip:: If using the Linux AppImage, replace ``sunshine`` with ``./sunshine.AppImage`` .. Tip:: If using the Linux AppImage, replace ``sunshine`` with ``./sunshine.AppImage``
@@ -13,7 +15,7 @@ Usage
The web ui is available on `https://localhost:47990 <https://localhost:47990>`_ by default. You may replace The web ui is available on `https://localhost:47990 <https://localhost:47990>`_ by default. You may replace
`localhost` with your internal ip address. `localhost` with your internal ip address.
.. Tip:: Ignore any warning given by your browser about "insecure website". .. Attention:: Ignore any warning given by your browser about "insecure website".
.. Caution:: If running for the first time, make sure to note the username and password Sunshine showed to you, .. Caution:: If running for the first time, make sure to note the username and password Sunshine showed to you,
since you cannot get back later! since you cannot get back later!
@@ -24,7 +26,7 @@ Usage
.. Note:: Additionally, apps can be configured manually. `assets/apps_<os>.json` is an example of a list of .. Note:: Additionally, apps can be configured manually. `assets/apps_<os>.json` is an example of a list of
applications that are started just before running a stream. applications that are started just before running a stream.
.. Note:: Application list is not fully supported on MacOS .. Attention:: Application list is not fully supported on MacOS
#. In Moonlight, you may need to add the PC manually. #. In Moonlight, you may need to add the PC manually.
#. When Moonlight request you insert the correct pin on sunshine: #. When Moonlight request you insert the correct pin on sunshine:
@@ -38,7 +40,7 @@ Network
------- -------
Sunshine will be available on port 47990 by default. Sunshine will be available on port 47990 by default.
.. Warning:: Do not expose port 47990, or the web ui, to the internet! .. Danger:: Do not expose port 47990, or the web ui, to the internet!
Arguments Arguments
--------- ---------

4
docs/source/building/linux.rst
View File

@@ -5,7 +5,7 @@ Linux
Requirements Requirements
------------ ------------
.. Warning:: Installing these dependencies may break your distribution. It is recommended to build in a virtual machine .. Danger:: Installing these dependencies may break your distribution. It is recommended to build in a virtual machine
or to use the `Dockerfile builds`_ located in the `./scripts` directory. or to use the `Dockerfile builds`_ located in the `./scripts` directory.
Debian Bullseye Debian Bullseye
@@ -223,7 +223,7 @@ End of Life: April 2027
Build Build
----- -----
.. Caution:: Ensure you are in the build directory created during the clone step earlier before continuing. .. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing.
Debian based OSes Debian based OSes
.. code-block:: bash .. code-block:: bash

2
docs/source/building/macos.rst
View File

@@ -28,7 +28,7 @@ Install Requirements
Build Build
----- -----
.. Caution:: Ensure you are in the build directory created during the clone step earlier before continuing. .. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing.
.. code-block:: bash .. code-block:: bash

2
docs/source/building/windows.rst
View File

@@ -14,7 +14,7 @@ following packages using:
Build Build
----- -----
.. Caution:: Ensure you are in the build directory created during the clone step earlier before continuing. .. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing.
.. code-block:: batch .. code-block:: batch

2
docs/source/contributing/localization.rst
View File

@@ -22,7 +22,7 @@ The translations occur on
`CrowdIn <https://crowdin.com/project/sunshinestream>`_. Feel free to contribute to localization there. `CrowdIn <https://crowdin.com/project/sunshinestream>`_. Feel free to contribute to localization there.
Only elements of the API are planned to be translated. Only elements of the API are planned to be translated.
.. Note:: The rest API has not yet been implemented. .. Attention:: The rest API has not yet been implemented.
Translations Basics Translations Basics
- The brand names `SunshineStream` and `Sunshine` should never be translated. - The brand names `SunshineStream` and `Sunshine` should never be translated.