Merge pull request #4341 from chenyukang/trivial-fix-doc

Support RPC duplicate method name for different modules
nervosnetwork · Feb 8, 2024 · 1ee9c98 · 1ee9c98
2 parents d6e9341 + c7315fd
commit 1ee9c98
Show file tree

Hide file tree

Showing 7 changed files with 162 additions and 91 deletions.
diff --git a/devtools/doc/rpc-gen/src/gen.rs b/devtools/doc/rpc-gen/src/gen.rs
@@ -73,7 +73,11 @@ impl RpcModule {
                     .unwrap()
                     .replace("##", "######");
                 desc = strip_prefix_space(&desc);
-                format!("#### Method `{}`\n{}\n\n{}\n", name, signatures, desc,)
+                let link = format!("<a id=\"{}-{}\"></a>", capitlized.to_lowercase(), name);
+                format!(
+                    "{}\n#### Method `{}`\n{}\n\n{}\n",
+                    link, name, signatures, desc,
+                )
             })
             .collect::<Vec<_>>();
 

diff --git a/devtools/doc/rpc-gen/src/main.rs b/devtools/doc/rpc-gen/src/main.rs
@@ -9,7 +9,8 @@ use std::{fs, path::PathBuf};
 fn dump_openrpc_json() -> Result<(), Box<dyn std::error::Error>> {
     let json_dir = PathBuf::from(OPENRPC_DIR).join("json");
     let version = get_version();
-    checkout_tag_branch(&version);
+    let branch = get_current_git_branch();
+    checkout_openrpc_branch(&branch);
     fs::create_dir_all(&json_dir)?;
 
     for (name, mut doc) in all_rpc_docs() {

diff --git a/devtools/doc/rpc-gen/src/utils.rs b/devtools/doc/rpc-gen/src/utils.rs
@@ -54,13 +54,18 @@ pub(crate) fn get_version() -> String {
     version
 }
 
+pub(crate) fn get_current_git_branch() -> String {
+    run_command("git", &["rev-parse", "--abbrev-ref", "HEAD"], None)
+        .unwrap_or_else(|| "unknown".to_string())
+}
+
 pub(crate) fn get_commit_sha() -> String {
     let res = run_command("git", &["rev-parse", "HEAD"], Some(OPENRPC_DIR)).unwrap();
     eprintln!("commit sha: {:?}", res);
     res
 }
 
-pub(crate) fn checkout_tag_branch(version: &str) {
+pub(crate) fn checkout_openrpc_branch(version: &str) {
     let dir = Some(OPENRPC_DIR);
     let res = run_command("git", &["checkout", version], dir);
     if res.is_none() {

diff --git a/devtools/doc/rpc-gen/templates/markdown.tera b/devtools/doc/rpc-gen/templates/markdown.tera
@@ -6,7 +6,7 @@
   {%- set methods = menu["methods"] %}
     * [Module {{ menu["title"] }}](#module-{{ menu["name"] }}) {{ menu["link"] }}
     {%- for method in methods %}
-        * [Method `{{method}}`](#method-{{method}})
+        * [Method `{{method}}`](#{{ menu["name"] }}-{{method}})
     {%- endfor %}
 {%- endfor %}
 * [RPC Types](#rpc-types)

diff --git a/docs/ckb_rpc_openrpc b/docs/ckb_rpc_openrpc
diff --git a/rpc/README.md b/rpc/README.md
diff --git a/rpc/src/module/miner.rs b/rpc/src/module/miner.rs
@@ -157,7 +157,7 @@ pub trait MinerRpc {
     ///   "jsonrpc": "2.0",
     ///   "method": "submit_block",
     ///   "params": [
-    ///     "example",
+    ///     "work_id_example",
     ///     {
     ///       "header": {
     ///         "compact_target": "0x1e083126",
+1 −1		json/miner_rpc_doc.json
+708 −0		json/rich_indexer_rpc_doc.json