Merge pull request ethereum#306 from etclabscore/docs/core-geth-features

docs: core-geth features, generated API method docs
NoteGio · Feb 4, 2021 · 6dd9074 · 6dd9074
2 parents e24799e + 744cc6f
commit 6dd9074
Show file tree

Hide file tree

Showing 25 changed files with 23,420 additions and 26 deletions.
diff --git a/.gitignore b/.gitignore
@@ -26,6 +26,7 @@ build/_vendor/pkg
 /build/_workspace/
 /build/cache/
 /build/bin/
+/build/static/
 /geth*.zip
 
 # travis
@@ -54,4 +55,4 @@ les/transactions.rlp
 # Files generated by docs build
 /MANIFEST
 /manifest.json
-/site
+/site
diff --git a/Makefile b/Makefile
@@ -131,6 +131,9 @@ clean: clean-evmc
 mkdocs-serve: ## Serve generated documentation (during development)
 	@build/mkdocs-serve.sh
 
+docs-generate: ## Generate JSON RPC API documentation from the OpenRPC service discovery document.
+	env COREGETH_GEN_OPENRPC_DOCS=on go test -count=1 -run BuildStatic ./ethclient
+
 # The devtools target installs tools required for 'go generate'.
 # You need to put $GOBIN (or $GOPATH/bin) in your PATH to use 'go generate'.
 

diff --git a/docs/apis/jsonrpc-apis.md → docs/JSON-RPC-API/index.md b/docs/apis/jsonrpc-apis.md → docs/JSON-RPC-API/index.md
@@ -3,7 +3,7 @@ hide:
   - toc        # Hide table of contents
 ---
 
-# JSON-RPC APIs
+# Using JSON-RPC APIs
 
 ## Programmatically interfacing `geth` nodes