added readthedocs capability

.readthedocs.yaml

@@ -0,0 +1,25 @@
+# https://docs.readthedocs.io/en/stable/config-file/index.html
+
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+# # Build PDF & ePub
+formats: all
+#   - epub
+#   - pdf

docs/CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - `actions_bootstrap.ps1` - bumped module versions to latest
     - All Infra/Infrastructure references changed to Integration
     - Removed all test case uses of `Assert-MockCalled`
+    - Added support for readthedocs
 - Misc
     - Updated `settings.json` for tab requirements to support Readthedocs
     - Added `SECURITY.md`

docs/requirements.txt

@@ -0,0 +1,7 @@
+# https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/docs/requirements.txt
+# requirements.txt
+jinja2==3.0.3
+mkdocs>=1.4.2
+mkdocs-material>=9.0.12  #https://github.com/squidfunk/mkdocs-material
+pygments>=2.14.0
+# mdx_truly_sane_lists

mkdocs.yml

@@ -0,0 +1,95 @@
+# https://www.mkdocs.org/user-guide/configuration/
+# https://www.mkdocs.org/user-guide/writing-your-docs/
+# https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown
+# https://mkdocs.readthedocs.io/en/0.15.2/user-guide/writing-your-docs/
+# https://mkdocs.readthedocs.io/en/0.15.2/user-guide/styling-your-docs/
+# https://example-mkdocs-basic.readthedocs.io/en/latest/
+# https://github.com/mkdocs/mkdocs/blob/master/mkdocs.yml
+# https://squidfunk.github.io/mkdocs-material/creating-your-site/
+# mkdocs.yml
+
+site_name: pwshPlaces
+# site_url:
+repo_url: https://github.com/techthoughts2/pwshPlaces
+# repo_name:
+# edit_uri: edit/main/docs/
+# edit_uri_template:
+site_description: Search, discover, and identify PowerShell cloud commands across multiple cloud providers. # meta tag to the generated HTML header
+site_author: Jake Morrison # meta tag to the generated HTML header
+copyright: "pwshPlaces is licensed under the <a href='https://github.com/techthoughts2/pwshPlaces/blob/main/LICENSE'>MIT license"
+# remote_branch:
+# remote_name:
+# docs_dir: docs
+# site_dir:
+# extra_css:
+# extra_javascript:
+markdown_extensions:
+  # Python Markdown
+  - admonition
+  - toc:
+      permalink: true
+  # code highlighting
+  - pymdownx.highlight:
+      use_pygments: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+# extra_templates:
+# extra:
+theme:
+  name: material
+  language: en
+  # custom_dir: overrides
+  features:
+    # - navigation.tabs
+    # - navigation.tabs.sticky
+    # - navigation.path
+  # favicon:
+  # icon:
+  #   repo:
+  # font:
+  #   text: Work Sans
+  # logo:
+  # palette:
+  #   primary: teal
+  # palette:
+  #   # Palette toggle for light mode
+  #   - media: "(prefers-color-scheme: light)"
+  #     scheme: default
+  #     primary: light blue
+  #     accent: pink
+  #     toggle:
+  #       icon: material/brightness-7
+  #       name: Switch to dark mode
+
+    # # Palette toggle for dark mode
+    # - media: "(prefers-color-scheme: dark)"
+    #   scheme: slate
+    #   primary: indigo
+    #   accent: pink
+    #   toggle:
+    #     icon: material/brightness-4
+    #     name: Switch to light mode
+nav:
+  - Home: index.md
+  - Functions:
+    - Bing
+      - Find-BingPlace: Find-BingPlace.md
+      - Find-BingTimeZone: Find-BingTimeZone.md
+      - Invoke-BingGeoCode: Invoke-BingGeoCode.md
+      - Search-BingNearbyPlaces: Search-BingNearbyPlaces.md
+    - Google
+      - Find-GMapPlace: Find-GMapPlace.md
+      - Get-GMapPlaceDetails: Get-GMapPlaceDetails.md
+      - Get-GMapPlaceDetails: Get-GMapPlaceDetails.md
+      - Invoke-GMapGeoCode: Invoke-GMapGeoCode.md
+      - Search-GMapNearbyPlace: Search-GMapNearbyPlace.md
+      - Search-GMapText: Search-GMapText.md
+  - Getting An API Key:
+    - Bing Maps API Key: BingMapsAPI
+    - Google Maps API Key: GoogleMapsAPI.md
+  - FAQ: pwshPlaces-FAQ.md
+  - Change Log: CHANGELOG.md