Add readthedocs configuration (#128)

* Add basic rtd file

* Move reqs to docs folder

* Test no markdown

* Remove unused markdown-extensions and add docs/README

Author: nmuesch

.readthedocs.yml

@@ -0,0 +1,16 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation with MkDocs
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt

docs/README.md

@@ -0,0 +1,11 @@
+# datadog-api-client-python
+
+Collection of all of the Datadog public endpoints. For the official documentation, see the [Datadog API Reference](https://docs.datadoghq.com/api/).
+
+This python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
+
+Need help? Reach out to our awesome [support team](https://www.datadoghq.com/support/).
+
+## Author
+
+[email protected]

docs/requirements.txt

@@ -0,0 +1,10 @@
+    --use-feature=2020-resolver
+    mkdocs>=1.1.1
+    mkdocs-material>=5.2.1
+    mkdocs-minify-plugin>=0.3.0
+    mkdocs-git-revision-date-localized-plugin>=0.5.2
+    mkdocstrings>=0.11.0
+    pymdown-extensions>=7.1
+    mkdocs-material-extensions>=1.0
+    mkpatcher>=1.0.2
+    Pygments>=2.6.1

mkdocs.yml

@@ -50,57 +50,6 @@ plugins:
             show_root_heading: yes
             show_source: true
 
-markdown_extensions:
-  # Built-in
-  - markdown.extensions.abbr:
-  - markdown.extensions.admonition:
-  - markdown.extensions.footnotes:
-  - markdown.extensions.tables:
-  - markdown.extensions.toc:
-      permalink: true
-      toc_depth: "1-6"
-  # Extra
-  - pymdownx.arithmatex:
-  - pymdownx.betterem:
-      smart_enable: all
-  - pymdownx.caret:
-  - pymdownx.critic:
-  - pymdownx.details:
-  - pymdownx.emoji:
-      # https://github.com/twitter/twemoji
-      # https://raw.githubusercontent.com/facelessuser/pymdown-extensions/master/pymdownx/twemoji_db.py
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
-  - pymdownx.highlight:
-      guess_lang: false
-      linenums_style: pymdownx-inline
-      use_pygments: true
-  - pymdownx.inlinehilite:
-  - pymdownx.keys:
-  - pymdownx.magiclink:
-      repo_url_shortener: true
-      repo_url_shorthand: true
-      social_url_shortener: true
-      social_url_shorthand: true
-      provider: github
-      user: DataDog
-      repo: datadog-api-client-python
-  - pymdownx.mark:
-  - pymdownx.progressbar:
-  - pymdownx.smartsymbols:
-  - pymdownx.superfences:
-      custom_fences:
-        - name: mermaid
-          class: mermaid
-          format: !!python/name:pymdownx.superfences.fence_code_format
-        - name: math
-          class: arithmatex
-          format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
-  - pymdownx.tabbed:
-  - pymdownx.tasklist:
-      custom_checkbox: true
-  - pymdownx.tilde:
-
 extra:
   social:
     - icon: fontawesome/solid/blog

tox.ini

@@ -11,20 +11,7 @@ skip_install = true
 passenv = *
 basepython = python3
 deps =
-    --use-feature=2020-resolver
-    mkdocs>=1.1.1
-    ; theme
-    mkdocs-material>=5.2.1
-    ; plugins
-    mkdocs-minify-plugin>=0.3.0
-    mkdocs-git-revision-date-localized-plugin>=0.5.2
-    mkdocstrings>=0.11.0
-    ; Extensions
-    pymdown-extensions>=7.1
-    mkdocs-material-extensions>=1.0
-    mkpatcher>=1.0.2
-    ; Necessary for syntax highlighting in code blocks
-    Pygments>=2.6.1
+    -rdocs/requirements.txt
 setenv =
     ; Use a set timestamp for reproducible builds.
     ; See https://reproducible-builds.org/specs/source-date-epoch/