docs,mkdocs.yml,Makefile: improve docs

- Creates generated markdown docs for API methods
  ./docs/JSON-RPC-API/modules
- 'make docs-generate' (re)creates these files
- ./docs/core/index.md is added including some hopefully
  useful information about what makes core-geth core-geth

Date: 2021-01-15 06:43:58-06:00
Signed-off-by: meows <b5c6@protonmail.com>

.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

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'.
 

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