From 8fb52eab6f9a8593cb9e6cb16b651eb02483b35c Mon Sep 17 00:00:00 2001 From: Marco Stronati Date: Wed, 18 Jul 2018 09:07:39 +0200 Subject: [PATCH] Doc: add manual for all binaries --- Makefile | 9 ++++++-- docs/api/cli-commands.rst | 48 ++++++++++++++++++++++++++++++++++----- 2 files changed, 49 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index 9411d83ff..8c9b23cbc 100644 --- a/Makefile +++ b/Makefile @@ -51,8 +51,12 @@ $(addsuffix .test,${PACKAGES}): %.test: doc-html: all @dune build @doc - @./tezos-client -protocol PtCJ7pwoxe8JasnHY8YonnLYjcVHmhiARPJvqcC6VfHT5s8k8sY man -verbosity 3 -format html | sed "s/$HOME/\$HOME/g" > docs/api/tezos-client.html - @./tezos-admin-client man -verbosity 3 -format html | sed "s/$HOME/\$HOME/g" > docs/api/tezos-admin-client.html + @./tezos-client -protocol ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > docs/api/tezos-client.html + @./tezos-admin-client man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > docs/api/tezos-admin-client.html + @./tezos-signer man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > docs/api/tezos-signer.html + @./tezos-baker-alpha man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > docs/api/tezos-baker-alpha.html + @./tezos-endorser-alpha man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > docs/api/tezos-endorser-alpha.html + @./tezos-accuser-alpha man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > docs/api/tezos-accuser-alpha.html @mkdir -p $$(pwd)/docs/_build/api/odoc @rm -rf $$(pwd)/docs/_build/api/odoc/* @cp -r $$(pwd)/_build/default/_doc/* $$(pwd)/docs/_build/api/odoc/ @@ -97,5 +101,6 @@ clean: tezos-protocol-compiler \ $(foreach p, $(active_protocol_versions), tezos-baker-$(p) tezos-endorser-$(p) tezos-accuser-$(p)) @-${MAKE} -C docs clean + @-rm -f docs/api/tezos-{baker,endorser,accuser}-alpha.html docs/api/tezos-{admin-,}client.html docs/api/tezos-signer.html .PHONY: all test build-deps docker-image clean diff --git a/docs/api/cli-commands.rst b/docs/api/cli-commands.rst index 91b3a70dc..a98f4f5dd 100644 --- a/docs/api/cli-commands.rst +++ b/docs/api/cli-commands.rst @@ -12,19 +12,55 @@ using the following shell commands. tezos-admin-client man -verbosity 3 -.. _tezos_client_commands: +.. _client_manual: -Command line client -=================== +Client manual +============= .. raw:: html :file: tezos-client.html -.. _tezos_admin_client_commands: +.. _admin_client_manual: -Administration command line client -================================== +Admin-client manual +=================== .. raw:: html :file: tezos-admin-client.html + + +.. _signer_manual: + +Signer manual +============= + +.. raw:: html + :file: tezos-signer.html + + +.. _baker_manual: + +Baker manual +============ + +.. raw:: html + :file: tezos-baker-alpha.html + + +.. _endorser_manual: + +Endorser manual +=============== + +.. raw:: html + :file: tezos-endorser-alpha.html + + +.. _accuser_manual: + +Accuser manual +============== + +.. raw:: html + :file: tezos-accuser-alpha.html