docs(markdown): migrate docs from rst to md

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: docs
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+      - run: |
+          curl -sSL https://install.python-poetry.org | python3 - --version 1.5.1
+          pip install mkdocs mkdocs-material mkdocstrings-python
+      - name: Deploy to GitHub Pages
+        if: github.ref_name == 'main'
+        run: mkdocs gh-deploy --force --strict
+      - name: Build Docs
+        if: github.ref_name != 'main'
+        run: mkdocs build

.gitignore

@@ -101,9 +101,9 @@ celerybeat.pid
 
 # Environments
 .env
-.venv
+# ignore all venv with different Py versions
+.venv*
 env/
-venv/
 ENV/
 env.bak/
 venv.bak/

docs/api_reference/backend_confs.md

@@ -0,0 +1,3 @@
+# backend_confs
+
+::: pytest_splunk_addon_ui_smartx.backend_confs

docs/api_reference/base_test.md

@@ -0,0 +1,3 @@
+# base_test
+
+::: pytest_splunk_addon_ui_smartx.base_test

docs/api_reference/components/base_component.md

@@ -0,0 +1,3 @@
+# Base Component
+
+::: pytest_splunk_addon_ui_smartx.components.base_component

docs/api_reference/components/conf_table.md

@@ -0,0 +1,3 @@
+# Conf Table
+
+::: pytest_splunk_addon_ui_smartx.components.conf_table

docs/api_reference/components/controls/base_control.md

@@ -0,0 +1,3 @@
+# Base Control
+
+::: pytest_splunk_addon_ui_smartx.components.controls.base_control

docs/api_reference/components/controls/button.md

@@ -0,0 +1,3 @@
+# Button
+
+::: pytest_splunk_addon_ui_smartx.components.controls.button

docs/api_reference/components/controls/checkbox.md

@@ -0,0 +1,3 @@
+# Checkbox
+
+::: pytest_splunk_addon_ui_smartx.components.controls.checkbox

docs/api_reference/components/controls/index.md

@@ -0,0 +1,14 @@
+# Controls
+
+The following is the API Reference for SmartX Controls:
+
++ [Base Control](base_control.md)
++ [Button](button.md)
++ [Checkbox](checkbox.md)
++ [Learn More](learn_more.md)
++ [Message](message.md)
++ [Multi Select](multi_select.md)
++ [Oauth Select](oauth_select.md)
++ [Single Select](single_select.md)
++ [Textbox](textbox.md)
++ [Toggle](toggle.md)

docs/api_reference/components/controls/learn_more.md

@@ -0,0 +1,3 @@
+# Learn More
+
+::: pytest_splunk_addon_ui_smartx.components.controls.learn_more

docs/api_reference/components/controls/message.md

@@ -0,0 +1,3 @@
+# Message
+
+::: pytest_splunk_addon_ui_smartx.components.controls.message

docs/api_reference/components/controls/multi_select.md

@@ -0,0 +1,3 @@
+# Multi Select
+
+::: pytest_splunk_addon_ui_smartx.components.controls.multi_select

docs/api_reference/components/controls/oauth_select.md

@@ -0,0 +1,3 @@
+# Oauth Select
+
+::: pytest_splunk_addon_ui_smartx.components.controls.oauth_select

docs/api_reference/components/controls/single_select.md

@@ -0,0 +1,3 @@
+# Single Select
+
+::: pytest_splunk_addon_ui_smartx.components.controls.single_select

docs/api_reference/components/controls/textbox.md

@@ -0,0 +1,3 @@
+# Textbox
+
+::: pytest_splunk_addon_ui_smartx.components.controls.textbox

docs/api_reference/components/controls/toggle.md

@@ -0,0 +1,3 @@
+# Toggle
+
+::: pytest_splunk_addon_ui_smartx.components.controls.toggle

docs/api_reference/components/dropdown.md

@@ -0,0 +1,3 @@
+# Dropdown
+
+::: pytest_splunk_addon_ui_smartx.components.dropdown

docs/components/entity.rst → docs/api_reference/components/entity.md

@@ -1,6 +1,3 @@
-Entity
-======
+# Entity
 
 .. automodule:: pytest_splunk_addon_ui_smartx.components.entity
-   :members:
-   :show-inheritance:

docs/api_reference/components/index.md

@@ -0,0 +1,12 @@
+# Components
+
+The following is the API Reference for SmartX Components:
+
++ [Base Component](base_component.md)
++ [Conf Table](conf_table.md)
++ [Dropdown](dropdown.md)
++ [Entity](entity.md)
++ [Input table](input_table.md)
++ [Login](login.md)
++ [Table](table.md)
++ [Tabs](tabs.md)

docs/api_reference/components/input_table.md

@@ -0,0 +1,3 @@
+# Input table
+
+::: pytest_splunk_addon_ui_smartx.components.input_table

docs/api_reference/components/login.md

@@ -0,0 +1,3 @@
+# Login
+
+::: pytest_splunk_addon_ui_smartx.components.login

docs/api_reference/components/table.md

@@ -0,0 +1,3 @@
+# Table
+
+::: pytest_splunk_addon_ui_smartx.components.table

docs/api_reference/components/tabs.md

@@ -0,0 +1,3 @@
+# Tabs
+
+::: pytest_splunk_addon_ui_smartx.components.tabs

docs/api_reference/index.md

@@ -0,0 +1,32 @@
+
+The following is the API Reference for SmartX:
+
+- [backend_conf](backend_confs.md)
+- [base_test](base_test.md)
+- [plugin](plugin.md)
+- [utils](utils.md)
+- [Pages](pages/index.md)
+    + [Logging](pages/logging.md)
+    + [Login](pages/login.md)
+    + [Page](pages/page.md)
+    + [Proxy](pages/proxy.md)
+- [Components](components/index.md)
+    + [Base Component](components/base_component.md)
+    + [Conf Table](components/conf_table.md)
+    + [Dropdown](components/dropdown.md)
+    + [Entity](components/entity.md)
+    + [Input table](components/input_table.md)
+    + [Login](components/login.md)
+    + [Table](components/table.md)
+    + [Tabs](components/tabs.md)
+- [Controls](components/controls/index.md)
+    + [Base Control](components/controls/base_control.md)
+    + [Button](components/controls/button.md)
+    + [Checkbox](components/controls/checkbox.md)
+    + [Learn More](components/controls/learn_more.md)
+    + [Message](components/controls/message.md)
+    + [Multi Select](components/controls/multi_select.md)
+    + [Oauth Select](components/controls/oauth_select.md)
+    + [Single Select](components/controls/single_select.md)
+    + [Textbox](components/controls/textbox.md)
+    + [Toggle](components/controls/toggle.md)

docs/api_reference/pages/index.md

@@ -0,0 +1,8 @@
+# Pages
+
+The following is the API Reference for SmartX Pages:
+
++ [Logging](logging.md)
++ [Login](login.md)
++ [Page](page.md)
++ [Proxy](proxy.md)

docs/api_reference/pages/logging.md

@@ -0,0 +1,3 @@
+# Logging
+
+::: pytest_splunk_addon_ui_smartx.pages.logging

docs/api_reference/pages/login.md

@@ -0,0 +1,3 @@
+# Login
+
+::: pytest_splunk_addon_ui_smartx.pages.login

docs/api_reference/pages/page.md

@@ -0,0 +1,3 @@
+# Page
+
+::: pytest_splunk_addon_ui_smartx.pages.page

docs/api_reference/pages/proxy.md

@@ -0,0 +1,3 @@
+# Proxy
+
+::: pytest_splunk_addon_ui_smartx.pages.proxy

docs/api_reference/plugin.md

@@ -0,0 +1,3 @@
+# plugin
+
+::: pytest_splunk_addon_ui_smartx.plugin

docs/api_reference/utils.md

@@ -0,0 +1,3 @@
+# utils
+
+::: pytest_splunk_addon_ui_smartx.utils