Conversation
Reorganise the Sphinx manual into a 10-chapter structure that mirrors the WebRunner reference layout (Getting Started, Core API, Actions, User Templates, Reporting, Orchestration, Recording & Data, Tooling, Integrations, Reference) and add per-feature pages for everything shipped on the recent feature wave: - New English + Traditional Chinese pages for architecture, start_test / prepare_env, locust environment, action executor, parameter resolver, scenario modes, assertions, HTTP / WebSocket / gRPC / MQTT / socket users, metrics exporters, test record store, distributed master/worker, HAR import, SQLite persistence, MCP server, project scaffolding, exception hierarchy, and the API reference index. - Refresh installation, getting_started, cli, socket_server, generate_report, and gui pages so they cover the new extras, the CLI subcommand surface, the hardened control socket, all six report formats, and the live stats panel + JA/KO translations. - Drop the stale scheduler doc directories (LoadDensity has no scheduler; the page never matched real executor commands). - Upgrade conf.py to enable autodoc / autosummary / autosectionlabel / napoleon / mermaid, lazy-mock the optional runtime deps, and bring copyright forward; add sphinxcontrib-mermaid to docs/requirements. Rewrite the three READMEs (root, Traditional Chinese, Simplified Chinese) into the WebRunner-style layout: badge row, language switcher, full Table of Contents, Highlights, Installation (with extras matrix), Architecture diagram, Quick Start, Core API, Action Executor, User Templates per protocol, Parameter Resolver, Scenario Modes, Assertions & Extractors, Reports, Observability, Distributed runners, HAR record/replay, SQLite persistence, MCP server, Hardened Control Socket, GUI, CLI Usage, Test Record, Exception Handling, Logging, Supported Platforms, License.
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rebuild the Sphinx manual and the three READMEs (root + Traditional Chinese + Simplified Chinese) into a chapter-organised layout that mirrors the WebRunner reference structure, and add per-feature pages for everything shipped on the recent multi-protocol / observability / MCP wave.
Sphinx manual (En + Zh, 70 rst files total)
conf.pynow enables autodoc / autosummary / autosectionlabel / napoleon / mermaid and lazy-mocks every optional runtime dep so the RTD build does not need them installed.docs/requirements.txtgainssphinxcontrib-mermaid. The stalescheduler/doc directory is removed (LoadDensity has no scheduler).READMEs
Rewritten into the WebRunner-style layout: badge row (PyPI / Python / License / RTD), language switchers, full Table of Contents, Highlights, Installation with extras matrix, ASCII architecture diagram, Quick Start, Core API, Action Executor with LD_* table, per-protocol User Templates, Parameter Resolver, Scenario Modes, Assertions & Extractors, six report formats, three exporters, distributed runners, HAR import, SQLite persistence, MCP server, hardened control socket, GUI, CLI usage, Test Record, Exception hierarchy, Logging, Supported Platforms, License.
Test plan
python -c "import importlib.util; spec = importlib.util.spec_from_file_location('conf', 'docs/source/conf.py'); m = importlib.util.module_from_spec(spec); spec.loader.exec_module(m); print(m.project)"loads the newconf.pycleanly.pytest test/— 84 passed.