Skip to content

[Tooling] Add RST single-backtick guardrail #7862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ghost wants to merge 6 commits into from
Closed

[Tooling] Add RST single-backtick guardrail #7862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
906ed09
[Tooling] Add RST single-backtick guardrail
Noai-oss Mar 12, 2026
33e83f7
Merge branch 'develop' of https://github.com/PaddlePaddle/docs into f…
Noai-oss Mar 12, 2026
aee9255
[Tooling] Handle RST literal blocks in backtick guardrail
Noai-oss Mar 12, 2026
9e561d8
[Tooling] Support parsed-literal in backtick guardrail
Noai-oss Mar 13, 2026
45d8ea3
[Tooling] Add RST single-backtick baseline and diff script
Noai-oss Mar 13, 2026
063948c
[Tooling] Fix literal block indent baseline in checker
Noai-oss Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
repos:
- repo: local
hooks:
- id: check-rst-single-backticks
name: check invalid single backticks in rst
entry: python ci_scripts/check_rst_single_backticks.py
language: python
files: \.rst$
# Common hooks
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
Expand Down
283 changes: 283 additions & 0 deletions ci_scripts/baselines/rst_single_backticks_baseline_by_file.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
49 docs/api/paddle/Tensor__upper_cn.rst
25 docs/api/paddle/nn/functional/fractional_max_pool3d_cn.rst
25 docs/api/paddle/metric/Metric_cn.rst
24 docs/api/paddle/nn/functional/fractional_max_pool2d_cn.rst
22 docs/api/paddle/nn/FractionalMaxPool3D_cn.rst
22 docs/api/paddle/nn/FractionalMaxPool2D_cn.rst
18 docs/guides/advanced/gradient_clip_en.rst
17 docs/api/paddle/distributed/shard_layer_cn.rst
13 docs/api/paddle/sparse/masked_matmul_cn.rst
13 docs/api/paddle/nn/functional/binary_cross_entropy_with_logits_cn.rst
13 docs/api/paddle/nn/BCEWithLogitsLoss_cn.rst
12 docs/api/paddle/sparse/matmul_cn.rst
11 docs/api/paddle/nn/functional/multi_label_soft_margin_loss_cn.rst
11 docs/api/paddle/nn/functional/gaussian_nll_loss_cn.rst
11 docs/api/paddle/nn/NLLLoss_cn.rst
11 docs/api/paddle/nn/MultiLabelSoftMarginLoss_cn.rst
11 docs/api/paddle/linalg/lu_solve_cn.rst
10 docs/api/paddle/nn/functional/soft_margin_loss_cn.rst
10 docs/api/paddle/nn/functional/adaptive_max_pool3d_cn.rst
10 docs/api/paddle/nn/SoftMarginLoss_cn.rst
9 docs/api/paddle/sparse/nn/functional/attention_cn.rst
9 docs/api/paddle/sparse/mv_cn.rst
9 docs/api/paddle/shard_index_cn.rst
9 docs/api/paddle/nn/functional/binary_cross_entropy_cn.rst
9 docs/api/paddle/nn/functional/adaptive_max_pool2d_cn.rst
9 docs/api/paddle/nn/BCELoss_cn.rst
8 docs/guides/advanced/gradient_clip_cn.rst
8 docs/api/paddle/nn/functional/triplet_margin_loss_cn.rst
8 docs/api/paddle/nn/functional/adaptive_avg_pool3d_cn.rst
8 docs/api/paddle/nn/AdaptiveMaxPool3D_cn.rst
8 docs/api/paddle/nn/AdaptiveAvgPool3D_cn.rst
8 docs/api/paddle/linalg/corrcoef_cn.rst
8 docs/api/paddle/linalg/cholesky_inverse_cn.rst
8 docs/api/paddle/incubate/identity_loss_cn.rst
8 docs/api/paddle/distributed/fleet/utils/LocalFS_cn.rst
8 docs/api/paddle/distributed/fleet/utils/HDFSClient_cn.rst
7 docs/api/paddle/sparse/nn/Softmax_cn.rst
7 docs/api/paddle/sparse/mask_as_cn.rst
7 docs/api/paddle/sparse/cast_cn.rst
7 docs/api/paddle/slice_scatter_cn.rst
7 docs/api/paddle/nn/functional/sigmoid_focal_loss_cn.rst
7 docs/api/paddle/nn/functional/l1_loss_cn.rst
7 docs/api/paddle/nn/functional/adaptive_avg_pool2d_cn.rst
7 docs/api/paddle/nn/TripletMarginWithDistanceLoss_cn.rst
7 docs/api/paddle/nn/TripletMarginLoss_cn.rst
7 docs/api/paddle/nn/AdaptiveMaxPool2D_cn.rst
7 docs/api/paddle/nn/AdaptiveAvgPool2D_cn.rst
7 docs/api/paddle/atleast_2d_cn.rst
6 docs/api_guides/low_level/parameter_en.rst
6 docs/api_guides/low_level/parameter.rst
6 docs/api/paddle/vision/Overview_cn.rst
6 docs/api/paddle/static/Variable_cn.rst
6 docs/api/paddle/static/Overview_cn.rst
6 docs/api/paddle/sparse/addmm_cn.rst
6 docs/api/paddle/nn/functional/margin_ranking_loss_cn.rst
6 docs/api/paddle/nn/PoissonNLLLoss_cn.rst
6 docs/api/paddle/linalg/householder_product_cn.rst
6 docs/api/paddle/distribution/MultivariateNormal_cn.rst
6 docs/api/paddle/distributed/fleet/Fleet_cn.rst
5 docs/api/paddle/sparse/nn/functional/softmax_cn.rst
5 docs/api/paddle/sparse/divide_cn.rst
5 docs/api/paddle/nn/initializer/Dirac_cn.rst
5 docs/api/paddle/nn/functional/adaptive_log_softmax_with_loss_cn.rst
5 docs/api/paddle/nn/MarginRankingLoss_cn.rst
5 docs/api/paddle/matrix_transpose_cn.rst
5 docs/api/paddle/linalg/matrix_transpose_cn.rst
5 docs/api/paddle/incubate/asp/prune_model_cn.rst
5 docs/api/paddle/grad_cn.rst
5 docs/api/paddle/diagonal_cn.rst
4 docs/api/paddle/vision/ops/prior_box_cn.rst
4 docs/api/paddle/sparse/subtract_cn.rst
4 docs/api/paddle/sparse/nn/functional/max_pool3d_cn.rst
4 docs/api/paddle/sparse/nn/MaxPool3D_cn.rst
4 docs/api/paddle/sparse/multiply_cn.rst
4 docs/api/paddle/sparse/isnan_cn.rst
4 docs/api/paddle/sparse/add_cn.rst
4 docs/api/paddle/nn/functional/triplet_margin_with_distance_loss_cn.rst
4 docs/api/paddle/nn/functional/npair_loss_cn.rst
4 docs/api/paddle/nn/functional/multi_margin_loss_cn.rst
4 docs/api/paddle/nn/functional/mse_loss_cn.rst
4 docs/api/paddle/nn/functional/max_pool3d_cn.rst
4 docs/api/paddle/nn/functional/max_pool2d_cn.rst
4 docs/api/paddle/nn/functional/cosine_embedding_loss_cn.rst
4 docs/api/paddle/nn/MultiMarginLoss_cn.rst
4 docs/api/paddle/nn/MaxPool3D_cn.rst
4 docs/api/paddle/nn/MaxPool2D_cn.rst
4 docs/api/paddle/nn/MSELoss_cn.rst
4 docs/api/paddle/nn/LPPool2D_cn.rst
4 docs/api/paddle/nn/L1Loss_cn.rst
4 docs/api/paddle/nn/AvgPool3D_cn.rst
4 docs/api/paddle/nn/AvgPool2D_cn.rst
4 docs/api/paddle/einsum_cn.rst
4 docs/api/paddle/distribution/ContinuousBernoulli_cn.rst
4 docs/api/paddle/compat/Overview_cn.rst
4 docs/api/paddle/combinations_cn.rst
4 docs/api/paddle/cdist_cn.rst
3 docs/guides/flags/others_en.rst
3 docs/guides/flags/others_cn.rst
3 docs/guides/06_distributed_training/cluster_quick_start_fl_ps_cn.rst
3 docs/api/paddle/trunc_cn.rst
3 docs/api/paddle/sparse/pow_cn.rst
3 docs/api/paddle/sparse/expm1_cn.rst
3 docs/api/paddle/optimizer/lr/ReduceOnPlateau_cn.rst
3 docs/api/paddle/optimizer/lr/PiecewiseDecay_cn.rst
3 docs/api/paddle/nn/utils/weight_norm_cn.rst
3 docs/api/paddle/nn/functional/poisson_nll_loss_cn.rst
3 docs/api/paddle/nn/functional/nll_loss_cn.rst
3 docs/api/paddle/nn/functional/multi_label_margin_loss_cn.rst
3 docs/api/paddle/nn/functional/max_unpool3d_cn.rst
3 docs/api/paddle/nn/functional/max_unpool2d_cn.rst
3 docs/api/paddle/nn/functional/max_unpool1d_cn.rst
3 docs/api/paddle/nn/functional/lp_pool2d_cn.rst
3 docs/api/paddle/nn/functional/avg_pool3d_cn.rst
3 docs/api/paddle/nn/functional/avg_pool2d_cn.rst
3 docs/api/paddle/nn/MultiLabelMarginLoss_cn.rst
3 docs/api/paddle/msort_cn.rst
3 docs/api/paddle/masked_fill_cn.rst
3 docs/api/paddle/linalg/cholesky_cn.rst
3 docs/api/paddle/hypot_cn.rst
3 docs/api/paddle/distributed/to_distributed_cn.rst
3 docs/api/paddle/distributed/shard_optimizer_cn.rst
3 docs/api/paddle/compat/min_cn.rst
3 docs/api/paddle/compat/max_cn.rst
3 docs/api/paddle/amp/debugging/DebugMode_cn.rst
2 docs/guides/flags/debug_en.rst
2 docs/guides/flags/debug_cn.rst
2 docs/api/paddle/vision/ops/box_coder_cn.rst
2 docs/api/paddle/utils/cpp_extension/load_cn.rst
2 docs/api/paddle/unsqueeze_cn.rst
2 docs/api/paddle/triu_cn.rst
2 docs/api/paddle/tan_cn.rst
2 docs/api/paddle/static/nn/batch_norm_cn.rst
2 docs/api/paddle/static/Program_cn.rst
2 docs/api/paddle/static/IpuCompiledProgram_cn.rst
2 docs/api/paddle/squeeze_cn.rst
2 docs/api/paddle/sparse/tanh_cn.rst
2 docs/api/paddle/sparse/tan_cn.rst
2 docs/api/paddle/sparse/sum_cn.rst
2 docs/api/paddle/sparse/square_cn.rst
2 docs/api/paddle/sparse/sqrt_cn.rst
2 docs/api/paddle/sparse/sinh_cn.rst
2 docs/api/paddle/sparse/sin_cn.rst
2 docs/api/paddle/sparse/rad2deg_cn.rst
2 docs/api/paddle/sparse/nn/functional/relu_cn.rst
2 docs/api/paddle/sparse/nn/functional/relu6_cn.rst
2 docs/api/paddle/sparse/nn/functional/leaky_relu_cn.rst
2 docs/api/paddle/sparse/nn/ReLU_cn.rst
2 docs/api/paddle/sparse/nn/ReLU6_cn.rst
2 docs/api/paddle/sparse/nn/LeakyReLU_cn.rst
2 docs/api/paddle/sparse/neg_cn.rst
2 docs/api/paddle/sparse/log1p_cn.rst
2 docs/api/paddle/sparse/deg2rad_cn.rst
2 docs/api/paddle/sparse/atanh_cn.rst
2 docs/api/paddle/sparse/atan_cn.rst
2 docs/api/paddle/sparse/asinh_cn.rst
2 docs/api/paddle/sparse/asin_cn.rst
2 docs/api/paddle/sparse/abs_cn.rst
2 docs/api/paddle/sparse/Overview_cn.rst
2 docs/api/paddle/sinh_cn.rst
2 docs/api/paddle/signal/istft_cn.rst
2 docs/api/paddle/reshape_cn.rst
2 docs/api/paddle/poisson_cn.rst
2 docs/api/paddle/optimizer/lr/StepDecay_cn.rst
2 docs/api/paddle/optimizer/lr/CyclicLR_cn.rst
2 docs/api/paddle/nn/functional/hardtanh_cn.rst
2 docs/api/paddle/nn/MaxUnPool3D_cn.rst
2 docs/api/paddle/nn/MaxUnPool2D_cn.rst
2 docs/api/paddle/nn/MaxUnPool1D_cn.rst
2 docs/api/paddle/nn/LeakyReLU_cn.rst
2 docs/api/paddle/nn/InstanceNorm3D_cn.rst
2 docs/api/paddle/nn/InstanceNorm2D_cn.rst
2 docs/api/paddle/nn/InstanceNorm1D_cn.rst
2 docs/api/paddle/linalg/vecdot_cn.rst
2 docs/api/paddle/linalg/triangular_solve_cn.rst
2 docs/api/paddle/linalg/solve_cn.rst
2 docs/api/paddle/linalg/Overview_cn.rst
2 docs/api/paddle/ldexp_cn.rst
2 docs/api/paddle/isfinite_cn.rst
2 docs/api/paddle/is_tensor_cn.rst
2 docs/api/paddle/incubate/asp/reset_excluded_layers_cn.rst
2 docs/api/paddle/fft/irfftn_cn.rst
2 docs/api/paddle/distribution/Normal_cn.rst
2 docs/api/paddle/distribution/LKJCholesky_cn.rst
2 docs/api/paddle/distribution/Cauchy_cn.rst
2 docs/api/paddle/distributed/spawn_cn.rst
2 docs/api/paddle/distributed/parallelize_cn.rst
2 docs/api/paddle/cosh_cn.rst
2 docs/api/paddle/cos_cn.rst
2 docs/api/paddle/binomial_cn.rst
1 docs/index_cn.rst
1 docs/guides/flags/npu_en.rst
1 docs/guides/flags/npu_cn.rst
1 docs/guides/beginner/index_cn.rst
1 docs/api_guides/low_level/optimizer_en.rst
1 docs/api_guides/low_level/optimizer.rst
1 docs/api/paddle/true_divide_cn.rst
1 docs/api/paddle/tril_cn.rst
1 docs/api/paddle/t__cn.rst
1 docs/api/paddle/static/nn/group_norm_cn.rst
1 docs/api/paddle/static/CompiledProgram_cn.rst
1 docs/api/paddle/signal/stft_cn.rst
1 docs/api/paddle/scatter__cn.rst
1 docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst
1 docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst
1 docs/api/paddle/optimizer/lr/NoamDecay_cn.rst
1 docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst
1 docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst
1 docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst
1 docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst
1 docs/api/paddle/optimizer/lr/LinearLR_cn.rst
1 docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst
1 docs/api/paddle/optimizer/lr/LRScheduler_cn.rst
1 docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst
1 docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst
1 docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst
1 docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst
1 docs/api/paddle/optimizer/Adadelta_cn.rst
1 docs/api/paddle/not_equal_cn.rst
1 docs/api/paddle/nn/initializer/TruncatedNormal_cn.rst
1 docs/api/paddle/nn/functional/softmax__cn.rst
1 docs/api/paddle/nn/functional/smooth_l1_loss_cn.rst
1 docs/api/paddle/nn/functional/rnnt_loss_cn.rst
1 docs/api/paddle/nn/functional/relu__cn.rst
1 docs/api/paddle/nn/functional/prelu_cn.rst
1 docs/api/paddle/nn/functional/pixel_unshuffle_cn.rst
1 docs/api/paddle/nn/functional/pixel_shuffle_cn.rst
1 docs/api/paddle/nn/functional/max_pool1d_cn.rst
1 docs/api/paddle/nn/functional/lp_pool1d_cn.rst
1 docs/api/paddle/nn/functional/local_response_norm_cn.rst
1 docs/api/paddle/nn/functional/hinge_embedding_loss_cn.rst
1 docs/api/paddle/nn/functional/elu__cn.rst
1 docs/api/paddle/nn/functional/ctc_loss_cn.rst
1 docs/api/paddle/nn/functional/channel_shuffle_cn.rst
1 docs/api/paddle/nn/functional/avg_pool1d_cn.rst
1 docs/api/paddle/nn/functional/adaptive_max_pool1d_cn.rst
1 docs/api/paddle/nn/functional/adaptive_avg_pool1d_cn.rst
1 docs/api/paddle/nn/Unfold_cn.rst
1 docs/api/paddle/nn/SmoothL1Loss_cn.rst
1 docs/api/paddle/nn/SimpleRNNCell_cn.rst
1 docs/api/paddle/nn/RNNTLoss_cn.rst
1 docs/api/paddle/nn/Overview_cn.rst
1 docs/api/paddle/nn/ModuleDict_cn.rst
1 docs/api/paddle/nn/LocalResponseNorm_cn.rst
1 docs/api/paddle/nn/LayerDict_cn.rst
1 docs/api/paddle/nn/LSTM_cn.rst
1 docs/api/paddle/nn/LSTMCell_cn.rst
1 docs/api/paddle/nn/KLDivLoss_cn.rst
1 docs/api/paddle/nn/HingeEmbeddingLoss_cn.rst
1 docs/api/paddle/nn/Hardtanh_cn.rst
1 docs/api/paddle/nn/Hardswish_cn.rst
1 docs/api/paddle/nn/Hardsigmoid_cn.rst
1 docs/api/paddle/nn/Fold_cn.rst
1 docs/api/paddle/nn/CosineEmbeddingLoss_cn.rst
1 docs/api/paddle/nn/CTCLoss_cn.rst
1 docs/api/paddle/nn/BeamSearchDecoder_cn.rst
1 docs/api/paddle/neg__cn.rst
1 docs/api/paddle/metric/Recall_cn.rst
1 docs/api/paddle/metric/Precision_cn.rst
1 docs/api/paddle/less_than_cn.rst
1 docs/api/paddle/less_equal_cn.rst
1 docs/api/paddle/less_cn.rst
1 docs/api/paddle/isposinf_cn.rst
1 docs/api/paddle/isneginf_cn.rst
1 docs/api/paddle/isnan_cn.rst
1 docs/api/paddle/isinf_cn.rst
1 docs/api/paddle/incubate/nn/functional/fused_multi_head_attention_cn.rst
1 docs/api/paddle/incubate/nn/FusedLinear_cn.rst
1 docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst
1 docs/api/paddle/incubate/asp/decorate_cn.rst
1 docs/api/paddle/heaviside_cn.rst
1 docs/api/paddle/greater_than_cn.rst
1 docs/api/paddle/greater_equal_cn.rst
1 docs/api/paddle/frac_cn.rst
1 docs/api/paddle/fluid/Overview_cn.rst
1 docs/api/paddle/equal_cn.rst
1 docs/api/paddle/distributed/shard_scaler_cn.rst
1 docs/api/paddle/distributed/fleet/UtilBase_cn.rst
1 docs/api/paddle/device/Overview_cn.rst
1 docs/api/paddle/baddbmm__cn.rst
1 docs/api/paddle/as_tensor_cn.rst
1 docs/api/paddle/amp/debugging/compare_accuracy_cn.rst
1 docs/api/paddle/addmm__cn.rst
1 docs/api/paddle/Overview_cn.rst
Loading
Loading