CI: Add readthedocs.yaml configuration file (#681)

* CI: Add readthedocs.yaml configuration file * update docs requirements * update mkdocs requiremens * update docs requirements * removing old requirement of fontawesome --------- Co-authored-by: JulioPDX <[email protected]>
aristanetworks · Nov 6, 2023 · 3a1367d · 3a1367d
1 parent 0d501e6
commit 3a1367d
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 3 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,21 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation with mkdocs
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: false
+
+python:
+  install:
+    - requirements: ansible_collections/arista/cvp/docs/requirements.txt
diff --git a/ansible_collections/arista/cvp/docs/requirements.txt b/ansible_collections/arista/cvp/docs/requirements.txt
@@ -1,8 +1,7 @@
 mkdocs
 mkdocs-bootswatch
-mkdocs-material==8.5.7
+mkdocs-material==9.0.15
 mkdocs-material-extensions
-fontawesome-markdown
 pymdown-extensions
 mdx_truly_sane_lists
 mkdocs-git-revision-date-localized-plugin

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -74,7 +74,6 @@ plugins:
 markdown_extensions:
   - admonition
   - attr_list
-  - fontawesome_markdown
   - mdx_truly_sane_lists
   - smarty
   - pymdownx.arithmatex