Skip to content
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

docs: core-geth features, generated API method docs #306

Merged
merged 13 commits into from
Feb 4, 2021
Merged

docs: core-geth features, generated API method docs #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
75b4b1d
docs,mkdocs.yml,Makefile: improve docs
meowsbits Jan 15, 2021
7ab609f
Merge branch 'master' into docs/core-geth-features
meowsbits Jan 21, 2021
b6b1f4e
ethclient,node: refactors docs-gen code to own test file
meowsbits Jan 21, 2021
b11ef02
docs: add CSS that hides > 3rd level menus from TOC (markdown: `####`)
ziogaschr Jan 21, 2021
8e230e3
docs/assets/css/extra.css,ethclient: use h4 for param+result sections
meowsbits Jan 21, 2021
b7500a6
docs/JSON-RPC-API: regenerate for 8e230e35
meowsbits Jan 21, 2021
048f515
docs/assets/css: readd chris' ul ul ul
meowsbits Jan 22, 2021
529f361
docs/JSON-RPC-API/modules,ethclient: use deep-linkable method invocat…
meowsbits Jan 22, 2021
7809392
mkdocs.yml: line numbers in code blocks
meowsbits Jan 22, 2021
f89ffdf
Revert "docs/assets/css: readd chris' ul ul ul"
meowsbits Jan 22, 2021
cc5afb0
docs,ethclient: init ordering for bullet-point style printer
meowsbits Jan 23, 2021
de73918
docs/JSON-RPC-API/modules,ethclient: add generic param names to curl …
meowsbits Jan 23, 2021
744cc6f
ethclient: (lint) goimports
meowsbits Jan 23, 2021
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
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ build/_vendor/pkg
/build/_workspace/
/build/cache/
/build/bin/
/build/static/
/geth*.zip

# travis
Expand Down Expand Up @@ -54,4 +55,4 @@ les/transactions.rlp
# Files generated by docs build
/MANIFEST
/manifest.json
/site
/site
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'.

Expand Down
2 changes: 1 addition & 1 deletion docs/apis/jsonrpc-apis.md → docs/JSON-RPC-API/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ hide:
- toc # Hide table of contents
---

# JSON-RPC APIs
# Using JSON-RPC APIs

## Programmatically interfacing `geth` nodes

Expand Down
Loading