Revert configs pending https://github.com/mkdocstrings/mkdocstrings/p…

…ull/294/files
Aditya-Kapadiya · Jun 9, 2021 · 6942856 · 6942856
1 parent e51208e
commit 6942856
Show file tree

Hide file tree

Showing 5 changed files with 510 additions and 37 deletions.
diff --git a/mkdocs-pdf.yml b/mkdocs-pdf.yml
@@ -1,3 +1,233 @@
-# MkDocs configuration for PDF output
-# Usage: ENABLE_PDF_EXPORT=1 mkdocs build -f mkdocs-pdf.yml
-INHERIT: mkdocs-base.yml
+# MkDocs configuration
+# Used as base - look for .yml files with INHERIT
+site_name: Percona Monitoring and Management
+site_description: Documentation
+site_author: Percona LLC
+site_url: ""
+copyright: Percona LLC, &#169; 2021
+use_directory_urls: false
+repo_name: percona/pmm-doc
+repo_url: https://github.com/percona/pmm-doc
+edit_uri: edit/main/docs/
+
+theme:
+  name: material
+  logo: _images/percona-logo.svg
+
+extra_css:
+  - https://unicons.iconscout.com/release/v3.0.3/css/line.css
+  - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
+  - css/percona.css
+  - css/lightgallery.min.css
+
+extra_javascript:
+  - js/version-select.js
+  - js/toctree.js
+  - js/lightgallery.min.js
+
+markdown_extensions:
+    attr_list: {}
+    toc:
+        permalink: True
+    admonition: {}
+    def_list: {}
+    meta: {}
+    smarty:
+        smart_angled_quotes: true
+    pymdownx.details: {}
+    pymdownx.mark: {}
+    pymdownx.smartsymbols: {}
+    pymdownx.tabbed: {}
+    pymdownx.tilde: {}
+    pymdownx.superfences: {}
+    pymdownx.highlight:
+        linenums: false
+    plantuml_markdown: {}
+    lightgallery: {}
+
+plugins:
+    search: {}
+    git-revision-date: {}
+    macros:
+        include_yaml:
+          - 'variables.yml'
+    # https://pypi.org/project/mkdocs-exclude/
+    exclude:
+        glob:
+          - 'setting-up/client/docker.md'
+    # https://github.com/orzih/mkdocs-with-pdf
+    with-pdf:
+        output_path: '_pdf/PerconaMonitoringAndManagement-2.18.0.pdf'
+        cover_title: 'Documentation'
+        cover_subtitle: 2.18.0 (June 1, 2021)
+        author: 'Percona Technical Documentation Team'
+        cover_logo: docs/_images/PMM_Logo.svg
+        debug_html: false
+        custom_template_path: _resources/templates
+        enabled_if_env: ENABLE_PDF_EXPORT
+    # Check links - but extends build time significantly
+    # https://pypi.org/project/mkdocs-htmlproofer-plugin/
+#    htmlproofer: {}
+    mike:
+        version_selector: true
+        css_dir: css
+        javascript_dir: js
+        canonical_version: null
+
+extra: # Used in main.html template and can't be externalised
+    open_issue_text: '<i class="uil uil-exclamation-triangle"></i> Report a problem
+        with this page'
+    open_issue_subject: 'PMM2: doc issue on page '
+    open_issue_body: 'Please describe the issue here'
+    open_issue_tooltip: 'Report an issue with this page on GitHub'
+    edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
+    updated_text: '<i class="uil uil-refresh"></i> Page updated'
+    version:
+      provider: mike
+
+nav:
+  - Welcome: index.md
+  - Setting up:
+      - setting-up/index.md
+      - Server:
+          - setting-up/server/index.md
+          - setting-up/server/network.md
+          - setting-up/server/docker.md
+          - setting-up/server/virtual-appliance.md
+          - setting-up/server/aws.md
+          - setting-up/server/dbaas.md
+      - Client:
+          - setting-up/client/index.md
+          - setting-up/client/mysql.md
+          - setting-up/client/mongodb.md
+          - setting-up/client/postgresql.md
+          - setting-up/client/proxysql.md
+          - setting-up/client/aws.md
+          - setting-up/client/azure.md
+          - setting-up/client/google.md
+          - setting-up/client/linux.md
+          - setting-up/client/external.md
+          - setting-up/client/haproxy.md
+          - setting-up/client/remote.md
+  - Using:
+      - using/index.md
+      - using/interface.md
+      - using/alerting.md
+      - using/backup.md
+      - using/query-analytics.md
+      - Percona Platform:
+          - using/platform/index.md
+          - using/platform/security-threat-tool.md
+          - using/platform/dbaas.md
+  - How to:
+      - how-to/index.md
+      - how-to/configure.md
+      - how-to/upgrade.md
+      - how-to/secure.md
+      - how-to/optimize.md
+      - how-to/annotate.md
+      - how-to/backup.md
+      - how-to/render-dashboard-images.md
+      - how-to/troubleshoot.md
+  - Details:
+      - details/index.md
+      - details/architecture.md
+      - details/interface.md
+      - Dashboards:
+          - details/dashboards/index.md
+          - Insight:
+              - details/dashboards/dashboard-home.md
+              - details/dashboards/dashboard-advanced-data-exploration.md
+              - details/dashboards/dashboard-victoriametrics.md
+              - details/dashboards/dashboard-victoriametrics-agents-overview.md
+          - PMM:
+              - details/dashboards/dashboard-inventory.md
+          - OS Dashboards:
+              - details/dashboards/dashboard-cpu-utilization-details.md
+              - details/dashboards/dashboard-disk-details.md
+              - details/dashboards/dashboard-network-details.md
+              - details/dashboards/dashboard-memory-details.md
+              - details/dashboards/dashboard-node-temperature-details.md
+              - details/dashboards/dashboard-nodes-compare.md
+              - details/dashboards/dashboard-nodes-overview.md
+              - details/dashboards/dashboard-node-summary.md
+              - details/dashboards/dashboard-numa-details.md
+              - details/dashboards/dashboard-processes-details.md
+          - Prometheus Dashboards:
+              - details/dashboards/dashboard-prometheus-exporter-status.md
+              - details/dashboards/dashboard-prometheus-exporters-overview.md
+          - MySQL Dashboards:
+              - details/dashboards/dashboard-mysql-amazon-aurora-details.md
+              - details/dashboards/dashboard-mysql-command-handler-counters-compare.md
+              - details/dashboards/dashboard-mysql-innodb-compression-details.md
+              - details/dashboards/dashboard-mysql-innodb-details.md
+              - details/dashboards/dashboard-mysql-myisam-aria-details.md
+              - details/dashboards/dashboard-mysql-myrocks-details.md
+              - details/dashboards/dashboard-mysql-instance-summary.md
+              - details/dashboards/dashboard-mysql-instances-compare.md
+              - details/dashboards/dashboard-mysql-instances-overview.md
+              - details/dashboards/dashboard-mysql-wait-event-analyses-details.md
+              - details/dashboards/dashboard-mysql-performance-schema-details.md
+              - details/dashboards/dashboard-mysql-query-response-time-details.md
+              - details/dashboards/dashboard-mysql-replication-summary.md
+              - details/dashboards/dashboard-mysql-group-replication-summary.md
+              - details/dashboards/dashboard-mysql-table-details.md
+              - details/dashboards/dashboard-mysql-user-details.md
+              - details/dashboards/dashboard-mysql-tokudb-details.md
+          - MongoDB Dashboards:
+              - details/dashboards/dashboard-mongodb-cluster-summary.md
+              - details/dashboards/dashboard-mongodb-instance-summary.md
+              - details/dashboards/dashboard-mongodb-instances-overview.md
+              - details/dashboards/dashboard-mongodb-instances-compare.md
+              - details/dashboards/dashboard-mongodb-replset-summary.md
+              - details/dashboards/dashboard-mongodb-inmemory-details.md
+              - details/dashboards/dashboard-mongodb-mmapv1-details.md
+              - details/dashboards/dashboard-mongodb-wiredtiger-details.md
+          - PostgreSQL Dashboards:
+              - details/dashboards/dashboard-postgresql-instances-overview.md
+              - details/dashboards/dashboard-postgresql-instance-summary.md
+              - details/dashboards/dashboard-postgresql-instances-compare.md
+          - ProxySQL Dashboards:
+              - details/dashboards/dashboard-proxysql-instance-summary.md
+          - HA Dashboards:
+              - details/dashboards/dashboard-pxc-galera-node-summary.md
+              - details/dashboards/dashboard-pxc-galera-cluster-summary.md
+              - details/dashboards/dashboard-pxc-galera-nodes-compare.md
+              - details/dashboards/dashboard-haproxy-instance-summary.md
+      - Commands:
+          - details/commands/index.md
+          - details/commands/pmm-admin.md
+          - details/commands/pmm-agent.md
+      - details/api.md
+      - details/victoria-metrics.md
+      - details/glossary.md
+  - faq.md
+  - Release Notes:
+      - release-notes/index.md
+      - release-notes/2.18.0.md
+      - release-notes/2.17.0.md
+      - release-notes/2.16.0.md
+      - release-notes/2.15.1.md
+      - release-notes/2.15.0.md
+      - release-notes/2.14.0.md
+      - release-notes/2.13.0.md
+      - release-notes/2.12.0.md
+      - release-notes/2.11.1.md
+      - release-notes/2.11.0.md
+      - release-notes/2.10.1.md
+      - release-notes/2.10.0.md
+      - release-notes/2.9.1.md
+      - release-notes/2.9.0.md
+      - release-notes/2.8.0.md
+      - release-notes/2.7.0.md
+      - release-notes/2.6.1.md
+      - release-notes/2.6.0.md
+      - release-notes/2.5.0.md
+      - release-notes/2.4.0.md
+      - release-notes/2.3.0.md
+      - release-notes/2.2.2.md
+      - release-notes/2.2.1.md
+      - release-notes/2.2.0.md
+      - release-notes/2.1.0.md
+      - release-notes/2.0.1.md
+      - release-notes/2.0.0.md
diff --git a/mkdocs-percona.yml b/mkdocs-percona.yml
@@ -87,7 +87,6 @@ extra: # Used in main.html template and can't be externalised
     version:
       provider: mike
 
-# Common navigation for percona.com, netlify and PDF
 nav:
   - Welcome: index.md
   - Setting up:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,4 @@
-# MkDocs configuration
-# Used as base - look for .yml files with INHERIT
+# MkDocs configuration for themed output
 site_name: Percona Monitoring and Management
 site_description: Documentation
 site_author: Percona LLC
@@ -38,36 +37,37 @@ extra_javascript:
   - js/lightgallery.min.js
 
 markdown_extensions:
-    attr_list: {}
-    toc:
+    - attr_list
+    - toc:
         permalink: True
-    admonition: {}
-    def_list: {}
-    meta: {}
-    smarty: { smart_angled_quotes: true }
-    pymdownx.details: {}
-    pymdownx.mark: {}
-    pymdownx.smartsymbols: {}
-    pymdownx.tabbed: {}
-    pymdownx.tilde: {}
-    pymdownx.superfences: {}
-    pymdownx.highlight:
+    - admonition
+    - def_list
+    - meta
+    - smarty:
+        smart_angled_quotes: true
+    - pymdownx.details
+    - pymdownx.mark
+    - pymdownx.smartsymbols
+    - pymdownx.tabbed
+    - pymdownx.tilde
+    - pymdownx.superfences
+    - pymdownx.highlight:
         linenums: false
-    plantuml_markdown: {}
-    lightgallery: {}
+    - plantuml_markdown
+    - lightgallery
 
 plugins:
-    search: {}
-    git-revision-date: {}
-    macros:
+    - search
+    - git-revision-date
+    - macros:
         include_yaml:
-          - 'variables.yml'
+            - variables.yml'
     # https://pypi.org/project/mkdocs-exclude/
-    exclude:
+    - exclude:
         glob:
           - 'setting-up/client/docker.md'
     # https://github.com/orzih/mkdocs-with-pdf
-    with-pdf:
+    - with-pdf:
         output_path: '_pdf/PerconaMonitoringAndManagement-2.18.0.pdf'
         cover_title: 'Documentation'
         cover_subtitle: 2.18.0 (June 1, 2021)
@@ -76,15 +76,12 @@ plugins:
         debug_html: false
         custom_template_path: _resources/templates
         enabled_if_env: ENABLE_PDF_EXPORT
-    # Check links - but extends build time significantly
-    # https://pypi.org/project/mkdocs-htmlproofer-plugin/
-#    htmlproofer: {}
-    mike:
-      version_selector: true
-      css_dir: css
-      javascript_dir: js
-      canonical_version: null
-    section-index: {}
+    - mike:
+        version_selector: true
+        css_dir: css
+        javascript_dir: js
+        canonical_version: null
+    - section-index
 
 extra: # Used in main.html template and can't be externalised
     open_issue_text: '<i class="uil uil-exclamation-triangle"></i> Report a problem
@@ -97,7 +94,6 @@ extra: # Used in main.html template and can't be externalised
     version:
       provider: mike
 
-# Common navigation for percona.com, netlify and PDF
 nav:
   - Welcome: index.md
   - Setting up: