chore: Update GitHub Actions workflows for documentation and MR tests

Signed-off-by: longhao <hal.long@outlook.com>

.github/workflows/docs.yml

@@ -9,6 +9,7 @@ on:
       - '**.rst'
       - 'nox_actions/docs.py'
       - 'pyproject.toml'
+      - '.github/workflows/docs.yml'
   push:
     branches: [ main ]
     paths:
@@ -17,6 +18,7 @@ on:
       - '**.rst'
       - 'nox_actions/docs.py'
       - 'pyproject.toml'
+      - '.github/workflows/docs.yml'
 
 permissions:
   contents: write
@@ -53,7 +55,7 @@ jobs:
         run: |
           # Build English documentation
           sphinx-build -b html -D language=en docs/source docs/build/html/en
-          
+
           # Build Chinese documentation
           sphinx-intl build
           sphinx-build -b html -D language=zh_CN docs/source docs/build/html/zh_CN

.github/workflows/mr-test.yml

@@ -5,6 +5,8 @@ on:
       - '**.md'
       - '.github/**'
       - '!.github/workflows/**'
+      - 'docs/**'
+      - '**.rst'
 
 jobs:
   lint:

README.md

@@ -11,7 +11,7 @@
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/loonghao/persistent_ssh_agent/graphs/commit-activity)
 [![Codecov](https://img.shields.io/codecov/c/github/loonghao/persistent_ssh_agent)](https://codecov.io/gh/loonghao/persistent_ssh_agent)
 
-[English](README.md) | [中文](README_zh.md)
+[English](./README.md) | [中文](./README_zh.md)
 
 🔐 A modern Python library for persistent SSH agent management across sessions.
 
@@ -20,7 +20,7 @@
 - [Features](#features)
 - [Installation](#installation)
 - [Usage](#usage)
-- [Security](#security-features)
+- [Security Features](#security-features)
 - [Contributing](#contributing)
 
 ## ✨ Features
@@ -385,7 +385,7 @@ Supported configuration categories:
 - **Environment Settings**: RequestTTY, SendEnv
 - **Multiplexing Options**: ControlMaster, ControlPath, ControlPersist
 
-For detailed validation rules and supported options, see [SSH Configuration Validation](docs/ssh_config_validation.md)
+For detailed validation rules and supported options, see [SSH Configuration Validation](#ssh-configuration-validation)
 
 ### Security Features
 
@@ -436,4 +436,4 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 
 ## 📄 License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](#license) file for details.

docs/source/conf.py

@@ -23,6 +23,19 @@
     "myst_parser",  # Add support for markdown files
 ]
 
+# MyST Parser settings
+myst_enable_extensions = [
+    "colon_fence",  # Enable ::: fences
+    "deflist",      # Enable definition lists
+    "fieldlist",    # Enable field lists
+    "eval",         # Enable evaluate-rst
+]
+myst_disable_all_warnings = True  # Disable all MyST warnings
+suppress_warnings = [
+    "myst.xref_missing",  # Suppress missing reference warnings
+    "ref.class"  # Suppress class reference warnings
+]
+
 # -- Options for HTML output -------------------------------------------------
 html_theme = "furo"
 html_static_path = ["_static"]

docs/source/index.rst

@@ -1,13 +1,14 @@
 Welcome to persistent_ssh_agent's documentation!
 =================================================
 
-.. only:: language == 'zh_CN'
+.. only:: language == 'zh'
 
    .. include:: readme_zh.rst
 
-.. only:: language == 'en_US' or language is undefined
+.. only:: language != 'zh'
 
-   .. include:: readme.rst
+   .. include:: readme.md
+   :parser: myst_parser.sphinx_
 
 .. toctree::
    :maxdepth: 2