Ver código fonte

book: Build RPC docs for darkfid2.

parazyd 4 anos atrás
pai
commit
a1aeade1e8
2 arquivos alterados com 11 adições e 5 exclusões
  1. 10 3
      doc/Makefile
  2. 1 2
      doc/build_jsonrpc.py

+ 10 - 3
doc/Makefile

@@ -1,9 +1,16 @@
 .POSIX:
 
+DARKFID_JSONRPC = src/clients/darkfid_jsonrpc.md
+
 all:
-	echo "# darkfid JSON-RPC API" > src/clients/darkfid_jsonrpc.md
-	./build_jsonrpc.py ../bin/darkfid/src/main.rs \
-		>> src/clients/darkfid_jsonrpc.md
+	echo "# darkfid JSON-RPC API" > $(DARKFID_JSONRPC)
+	./build_jsonrpc.py ../bin/darkfid2/src/main.rs >> $(DARKFID_JSONRPC)
+	echo "## blockchain methods" >> $(DARKFID_JSONRPC)
+	./build_jsonrpc.py ../bin/darkfid2/src/rpc_blockchain.rs >> $(DARKFID_JSONRPC)
+	echo "## wallet methods" >> $(DARKFID_JSONRPC)
+	./build_jsonrpc.py ../bin/darkfid2/src/rpc_wallet.rs >> $(DARKFID_JSONRPC)
+	echo "## miscellaneous methods" >> $(DARKFID_JSONRPC)
+	./build_jsonrpc.py ../bin/darkfid2/src/rpc_misc.rs >> $(DARKFID_JSONRPC)
 
 	echo "# cashierd JSON-RPC API" > src/clients/cashierd_jsonrpc.md
 	./build_jsonrpc.py ../bin/cashierd/src/main.rs \

+ 1 - 2
doc/build_jsonrpc.py

@@ -41,9 +41,8 @@ def main(path):
 
             comment += i[3:] + "\n"
 
-    print("\n## Methods")
     for i in methods:
-        print(f"* [`{i[0]}`](#{i[0]})")
+        print(f"* [`{i[0]}`](#{i[0].replace('.', '')})")
 
     print("\n")
     for i in methods: