Merge pull request #911 from flash62au/sphinx

Change to make External URLs open in a new page

docs/_templates/footer.html

@@ -4,4 +4,12 @@
     <div class="topOfPage">
     <button onclick="document.body.scrollTop=0;document.documentElement.scrollTop=0;" class="topOfPageBtn" id="topOfPageBtn" title="Go to top">Top</button>
     </div>
+
+    <script type="text/javascript">
+      <!-- Adds target=_blank to external links -->
+
+      $(document).ready(function () {
+        $('a[href^="http://"], a[href^="https://"]').not('a[class*=internal]').not('a[href^="https://dcc-ex.com/"]').attr('target', '_blank');
+      });
+    </script>
   {% endblock %}

docs/about/contributing/donate.rst

@@ -27,25 +27,25 @@ Donation Options
 
 .. rst-class:: dcclink
 
-  `PayPal <https://paypal.me/fndecker>`_
+  `PayPal <https://paypal.me/fndecker>`_ |EXTERNAL-LINK|
 
 Or choose user @FNDecker in your PayPal App
 
 .. rst-class:: dcclink
 
-  `Venmo <https://venmo.com/fndecker>`_
+  `Venmo <https://venmo.com/fndecker>`_ |EXTERNAL-LINK|
 
 Or choose user @FNDecker in your Venmo App
 
 .. rst-class:: dcclink
 
-  `Patreon <https://patreon.com/dccex>`_
+  `Patreon <https://patreon.com/dccex>`_ |EXTERNAL-LINK|
 
 Or choose user "dccex" on Patreon
 
 .. rst-class:: dcclink
 
-  `Github Sponsors <https://github.com/sponsors/DCC-EX>`_
+  `Github Sponsors <https://github.com/sponsors/DCC-EX>`_ |EXTERNAL-LINK|
 
 We are DCC-EX on GitHub Sponsors. You can also donate from our |EX-CS| repository page by scrolling down the right side column.
 

docs/about/contributing/github.rst

@@ -17,7 +17,7 @@ GitHub
 
 While you don't need to be an expert, you should have some knowledge about Git and GitHub, as we manage all of our code and documentation there.
 
-All development and documentation related repositories are located in the `DCC-EX GitHub organisation <https://github.com/DCC-EX>`_.
+All development and documentation related repositories are located in the `DCC-EX GitHub organisation <https://github.com/DCC-EX>`_ |EXTERNAL-LINK|.
 
 Depending on the editing platform of your choice, you may get all the Git functionality you need, however you may optionally want to install GitHub Desktop or Sourcetree for getting a good idea on the state of the various |DCC-EX| repositories.
 
@@ -37,14 +37,14 @@ GitHub account
 
 To start with, you will of course require an account on GitHub. If you have one already for your own personal projects, or contributing to other projects, you can simply use this. There is no need to have multiple GitHub accounts.
 
-If you don't have one at all, then you'll need to `sign up <https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home>`_.
+If you don't have one at all, then you'll need to `sign up <https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home>`_ |EXTERNAL-LINK|.
 
 Git terms: fork, branch, pull request, and merge
 =================================================
 
 If you're brand new to using Git and GitHub, you will no doubt be instantly confused by four terms commonly used by Git users; fork, branch, pull request, and merge.
 
-If you're not familiar with these, we provide a very brief overview below, however we highly recommend reading GitHub's documentation: `Collaborate with pull requests <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests>`_.
+If you're not familiar with these, we provide a very brief overview below, however we highly recommend reading GitHub's documentation: `Collaborate with pull requests <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests>`_ |EXTERNAL-LINK|.
 
 Fork
 ----

docs/about/contributing/overview.rst

@@ -54,7 +54,7 @@ There is a repository within the DCC-EX GitHub organisation where we are slowly
 
 This repository will contain the various workflows, templates, and testing items we will use to ensure we release quality code with as few bugs (or "hidden features") as possible, and to ensure code is consistent across an internationally dispersed team.
 
-This is our `Support Planning <https://github.com/DCC-EX/Support-Planning>`_ repository.
+This is our `Support Planning <https://github.com/DCC-EX/Support-Planning>`_ |EXTERNAL-LINK| repository.
 
 Contacting the team
 ====================

docs/about/contributing/software.rst

@@ -24,7 +24,7 @@ Firstly, in order to work with our code, you will require access to a Git client
 
 If you have a Linux based system (including macOS), you more than likely have Git installed already, so probably don't need to install it.
 
-However, for Windows, you will need to install Git, so follow the instructions in the `Pro Git book <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_.
+However, for Windows, you will need to install Git, so follow the instructions in the `Pro Git book <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_ |EXTERNAL-LINK|.
 
 Once you've installed Git, you will need to set some variables to tell Git who you are when committing code to a repository.
 
@@ -44,11 +44,11 @@ Other handy Git software
 
 GitHub Desktop is an application by GiHub that provides a graphical user interface for managing Git repositories and so forth:
 
-Download `GitHub Desktop <https://desktop.github.com/>`_
+Download `GitHub Desktop <https://desktop.github.com/>`_ |EXTERNAL-LINK|
 
 Another graphical alternative is Sourcetree:
 
-Download `Sourcetree <https://www.sourcetreeapp.com/>`_
+Download `Sourcetree <https://www.sourcetreeapp.com/>`_ |EXTERNAL-LINK|
 
 Arduino IDE
 ============
@@ -57,12 +57,12 @@ If you're already using |DCC-EX|, then it's likely you've already installed the
 
 However, if you haven't, it's recommended to have this installed, even if using our recommended editor (VSCode). It's handy to see the same interface that most of our users can see, as they will almost certainly be using the Arduino IDE, and providing support is so much easier when you can use the same tools as the users.
 
-To get up and running with the Arduino IDE, follow the `Getting started with Arduino products <https://www.arduino.cc/en/Guide>`_ page.
+To get up and running with the Arduino IDE, follow the `Getting started with Arduino products <https://www.arduino.cc/en/Guide>`_ |EXTERNAL-LINK| page.
 
 ESP32 support
 -------------
 
-If you need ESP32 support in addition to the standard Arduino AVR boards, follow the official `Espressif Arduino ESP32 documentation <https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html>`_.
+If you need ESP32 support in addition to the standard Arduino AVR boards, follow the official `Espressif Arduino ESP32 documentation <https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html>`_ |EXTERNAL-LINK|.
 
 Python 3.x
 ===========
@@ -75,9 +75,9 @@ All website documentation is written in reStructuredText format and built using
 
 In order to correctly preview changes to the website documentation locally on your computer before publishing to the website, you will need to install Python, preferably the latest 3.x version available.
 
-You can obtain Python from `python.org <https://www.python.org/downloads/>`_ or, alternatively, you can install it from the Microsoft store for Windows users.
+You can obtain Python from `python.org <https://www.python.org/downloads/>`_ |EXTERNAL-LINK| or, alternatively, you can install it from the Microsoft store for Windows users.
 
-For Windows users, follow the official Python documentation here: `Using Python on Windows <https://docs.python.org/3/using/windows.html>`_.
+For Windows users, follow the official Python documentation here: `Using Python on Windows <https://docs.python.org/3/using/windows.html>`_ |EXTERNAL-LINK|.
 
 Note that you will need to ensure Python is added to your `PATH` environment variable which is outlined on that page also.
 
@@ -96,7 +96,7 @@ While any text editor will do, even the most simple one, we highly recommend usi
 
 VSCode is great whether you're contributing as a developer or documenter, and we cover the requirements for both use cases here.
 
-You can download VSCode `here <https://code.visualstudio.com/download>`_.
+You can download VSCode `here <https://code.visualstudio.com/download>`_ |EXTERNAL-LINK|.
 
 VSCode includes many different extensions and configuration options to enable the various syntax checks and other additional components, so please review the below to ensure the right configuration and extensions are in place to make things easier for yourself.
 

docs/about/contributing/website/requirements.rst

@@ -30,29 +30,29 @@ Just go to the Contact Us section, and we will find a way of getting you on boar
 reStructuredText
 ----------------
 
-All documentation is done using reStructuredText, for which you can find information on the official website: `reStructuredText <https://docutils.sourceforge.io/rst.html>`_
-or the `Sphinx <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ document builder tool website, which we discuss later on in this chapter.
+All documentation is done using reStructuredText, for which you can find information on the official website: `reStructuredText <https://docutils.sourceforge.io/rst.html>`_ |EXTERNAL-LINK|
+or the `Sphinx <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ |EXTERNAL-LINK| document builder tool website, which we discuss later on in this chapter.
 reStructuredText is a markdown type language, for typesetting documents from websites to PDF or LaTeX documents. Our Website is built upon this technology, so you should make yourself familiar with this by looking through the links provided.
 
-reStructuredText `QuickReference Guide <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_ 
+reStructuredText `QuickReference Guide <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_ |EXTERNAL-LINK| 
 
 Git & GitHub
 ------------
 
 You should have some knowledge about Git and GitHub, as we manage all of our documentation (as well as the development) there. Depending on the editing platform of your choice, you may get all the Git functionality you need. You may want to install GitHub Desktop or Sourcetree for getting a good idea on the state of the |EX-CS| documentation GitHub repository (dcc-ex.github.io).
 
-If you don't have Git installed, now is as good a time as any, follow the instructions in the `Pro Git book <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_
+If you don't have Git installed, now is as good a time as any, follow the instructions in the `Pro Git book <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_ |EXTERNAL-LINK|
 
-Download `GitHub Desktop <https://desktop.github.com/>`_
+Download `GitHub Desktop <https://desktop.github.com/>`_ |EXTERNAL-LINK|
 
-Download `SourceTree <https://www.sourcetreeapp.com/>`_
+Download `SourceTree <https://www.sourcetreeapp.com/>`_ |EXTERNAL-LINK|
 
 Editing
 -------
 
 You will also need to choose a text editor. Yes, any text editor will do, even the most simple one, but they will not provide editing help. We suggest you use the free VSCode (Visual Studio Code) which provides additional components that will make your editing easier with syntax highlighting, text snippets, and live preview of the rendering of the file, as well as integration with GitHub. Using a simple text editor will require you handling the Git integration yourself.
 
-Download VSCode `here <https://code.visualstudio.com/download>`_
+Download VSCode `here <https://code.visualstudio.com/download>`_ |EXTERNAL-LINK|
 
 Install the following extensions:
 

docs/about/contributing/webthrottle.rst

@@ -33,17 +33,17 @@ Developer tools
 	You may want to have a look at our page on :doc:`/about/contributing/software` and also our page on :doc:`/about/contributing/github` if you've never used git or GitHub before
 
 We strongly recommend using Visual Studio Code (VSCode) to work on EX-WebThrottle2. 
-You can download it from Microsoft's website `here <https://code.visualstudio.com/>`__.
+You can download it from Microsoft's website `here <https://code.visualstudio.com/>`__ |EXTERNAL-LINK|.
 Whilst you are waiting for it to install, you can be getting a local copy of the code.
 
 Once you have downloaded VSCode and installed it, open VSCode then click :menuselection:`File --> Open Workspace from file...` then find your local copy of the code and select "EX-WebThrottle2.code-workspace". 
 Once VSCode has loaded the workspace, you should see a popup in the bottom right asking you if you want to install the recommended extensions. 
 It's recommended you install these and they are:
 
-- `Volar <https://marketplace.visualstudio.com/items?itemName=Vue.volar>`__
-- `Vuetify <https://marketplace.visualstudio.com/items?itemName=vuetifyjs.vuetify-vscode>`__
-- `ESLint <https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint>`__
-- `Spell Checker <https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker>`__
+- `Volar <https://marketplace.visualstudio.com/items?itemName=Vue.volar>`__ |EXTERNAL-LINK|
+- `Vuetify <https://marketplace.visualstudio.com/items?itemName=vuetifyjs.vuetify-vscode>`__ |EXTERNAL-LINK|
+- `ESLint <https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint>`__ |EXTERNAL-LINK|
+- `Spell Checker <https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker>`__ |EXTERNAL-LINK|
 
 You'll need to set up Volar to handle TypeScript, instead of the built in TypeScript extension. To do this, follow these steps:
 
@@ -52,7 +52,7 @@ You'll need to set up Volar to handle TypeScript, instead of the built in TypeSc
 #. Find TypeScript and JavaScript Language Features, right click and select `Disable (Workspace)`
 #. Reload VSCode, and then open any vue file to trigger Volar activation (no longer need in 0.28.4).
 
-Next you'll need to install Node.js to run the development tools. Again, you can download it from their website `here <https://nodejs.org/en/>`__.
+Next you'll need to install Node.js to run the development tools. Again, you can download it from their website `here <https://nodejs.org/en/>`__ |EXTERNAL-LINK|.
 We recommend you use the LTS version of Node.
 
 Once Node is installed, open a terminal in VSCode (:menuselection:`Terminal --> New terminal`) and run the following command to install all the dependencies:
@@ -71,7 +71,7 @@ Then to run the code locally:
 Code standards
 --------------
 
-For EX-WebThrottle2, we follow the `Google Style Guides <https://google.github.io/styleguide/>`__, specifically the `HTML/CSS <https://google.github.io/styleguide/htmlcssguide.html>`__ and `TypeScript <https://google.github.io/styleguide/tsguide.html>`__ style guides. 
+For EX-WebThrottle2, we follow the `Google Style Guides <https://google.github.io/styleguide/>`__ |EXTERNAL-LINK|, specifically the `HTML/CSS <https://google.github.io/styleguide/htmlcssguide.html>`__ |EXTERNAL-LINK| and `TypeScript <https://google.github.io/styleguide/tsguide.html>`__ |EXTERNAL-LINK| style guides. 
 This means we use a indent of two spaces and single quotes for strings. 
 Also, although semicolons are optional in JavaScript, we have configured the linter to enforce semicolons. 
 If you have installed the recommended extensions, VSCode should highlight problems for you. 
@@ -122,7 +122,7 @@ An example would be: |BR|
 Or |BR|
 *Fix: button now works (#52)*
 
-If you feel able to, please consider signing your commits (See this guide if you want to have a go: `Verified commits - GitHub <https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification>`__).
+If you feel able to, please consider signing your commits (See this guide if you want to have a go: `Verified commits - GitHub <https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification>`__ |EXTERNAL-LINK|).
 
 
 Opening a pull request

docs/about/media-resources/index.rst

@@ -17,7 +17,7 @@ Let us help you to have everything you need to produce your content and receive
 
 * Find us on Discord
 * Send an email to [email protected]
-* Create a support request at https://dcc-ex.com/support/index.html#raise-a-support-ticket
+* Create a support request at https://dcc-ex.com/support/index.html#raise-a-support-ticket |EXTERNAL-LINK|
 
 Making videos or Live Demos
 ============================