[ 1.0.1 ] - 2023/10/28

  *  Added support for ReadtheDocs documentation hosting.

Author: thlucas1

Diff for: .gitignore

@@ -173,6 +173,5 @@ artifacts/
 /test/developer_notes.txt
 /test/stu/
 /Git*.cmd
-
 # include PDOC documentation
-#!docspdoc/build/
+!docspdoc/build/

Diff for: BoseSoundTouchApiProject.pyproj

@@ -206,9 +206,11 @@
     <Folder Include="test\" />
   </ItemGroup>
   <ItemGroup>
+    <Content Include=".gitattributes" />
     <Content Include=".github\ISSUE_TEMPLATE\bug.yml" />
     <Content Include=".github\ISSUE_TEMPLATE\config.yml" />
     <Content Include=".github\ISSUE_TEMPLATE\feature_request.yml" />
+    <Content Include=".gitignore" />
     <Content Include=".vscode\launch.json" />
     <Content Include=".vscode\settings.json" />
     <Content Include="build.bat" />
@@ -293,6 +295,7 @@
     <Content Include="docs\include\samplecode\SmartInspectPython\Overview.md" />
     <Content Include="LICENSE" />
     <Content Include="README.md" />
+    <Content Include="readthedocs.yaml" />
     <Content Include="requirements.txt" />
     <Content Include="test\developer_notes.txt" />
     <Content Include="test\smartinspect.cfg" />

Diff for: BoseSoundTouchApiProject.pyproj.user

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
-    <ProjectView>ShowAllFiles</ProjectView>
+    <ProjectView>ProjectFiles</ProjectView>
   </PropertyGroup>
 </Project>

Diff for: CHANGELOG.md

@@ -4,7 +4,7 @@
 # constants are placed in this file if they are used across multiple files.
 # the only exception to this is for the VERSION constant, which is placed here for convenience.
 
-VERSION:str = "1.0.0"
+VERSION:str = "1.0.1"
 """ 
 Current version of the Bose SoundTouch API Python3 Library. 
 """

Diff for: bosesoundtouchapi/bstconst.py

@@ -0,0 +1,70 @@
+// add event listener to call function after window has been completely loaded.
+window.addEventListener("load", codecopyAddLinkButtons, false);
+
+// ********************************************************************
+// add "Copy to Clipboard" button to all code hi-lite blocks.
+// ********************************************************************
+function codecopyAddLinkButtons(){
+
+    // get list of all code hilite blocks.
+    const codehilites = document.querySelectorAll("div.codehilite")
+
+    // add "copy" button to each element.
+    codehilites.forEach(div => {
+        const btnCopy = document.createElement("button")
+        btnCopy.innerHTML = "Copy to Clipboard"
+        btnCopy.addEventListener("click", codecopyClick)
+	btnCopy.style.top = "0px"
+	btnCopy.style.right = "0px"
+        div.append(btnCopy)
+    })
+}
+
+
+// ********************************************************************
+// handles the button click event.
+// copies the code hi-lite text to the clipboard.
+// ********************************************************************
+function codecopyClick(evt) {
+
+    // get the children of the parent element.
+    const { children } = evt.target.parentElement
+
+    // grab the second element (we append the copy button on afterwards, so the first will be the code element).
+    // destructure the innerText from the code block.
+    const { innerText } = Array.from(children)[0]
+
+    // copy all of the code to the clipboard.
+    copyToClipboard(innerText)
+
+    // inform the user it worked.
+    evt.target.innerHTML = "Code Copied to Clipboard"
+
+    // set button text back to normal after 2 seconds.
+    setTimeout(function() { evt.target.innerHTML = "Copy to Clipboard"; }, 2000);
+}
+
+
+// ********************************************************************
+// copies data to the clipboard.
+// ********************************************************************
+const copyToClipboard = str => {
+  const el = document.createElement("textarea") // Create a <textarea> element
+  el.value = str // Set its value to the string that you want copied
+  el.setAttribute("readonly", "") // Make it readonly to be tamper-proof
+  el.style.position = "absolute"
+  el.style.left = "-9999px" // Move outside the screen to make it invisible
+  document.body.appendChild(el) // Append the <textarea> element to the HTML document
+  const selected =
+    document.getSelection().rangeCount > 0 // Check if there is any content selected previously
+      ? document.getSelection().getRangeAt(0) // Store selection if found
+      : false // Mark as false to know no selection existed before
+  el.select() // Select the <textarea> content
+  document.execCommand("copy") // Copy - only works as a result of a user action (e.g. click events)
+  document.body.removeChild(el) // Remove the <textarea> element
+  if (selected) {
+    // If a selection existed before copying
+    document.getSelection().removeAllRanges() // Unselect everything on the HTML document
+    document.getSelection().addRange(selected) // Restore the original selection
+  }
+}

Diff for: docspdoc/build/__init__.html

@@ -0,0 +1,9 @@
+version: 2
+
+build:
+    os: ubuntu-20.04
+    tools:
+      python: "3.8"
+    commands: 
+      - mkdir --parents _readthedocs/html/
+      - cp --recursive docspdoc/build/* _readthedocs/html/

Diff for: docspdoc/build/bosesoundtouchapi.ico

@@ -85,9 +85,9 @@ def getDirFilesList(pathName:str) -> list[str]:
     ],
 
     # provide some links to list on the Pypi.org site.
-    #project_urls={
+    project_urls={
     #    'Documentation': 'https://example.com/documentation/',
-    #    'GitHub': 'https://github.com/foobar/foobar/',
-    #    'Changelog': 'https://github.com/foobar/foobar/blob/master/CHANGELOG.md',
-    #},
+        'GitHub': 'https://github.com/thlucas1/bosesoundtouchapi',
+        'Changelog': 'https://github.com/thlucas1/bosesoundtouchapi/blob/master/CHANGELOG.md',
+    }
 )