balsoft/ligo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Doc: add manual for all binaries

Browse Source
This commit is contained in:
Marco Stronati 2018-07-18 09:07:39 +02:00
parent 3b6e41b0e5
commit 8fb52eab6f
2 changed files with 49 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Makefile
View File

@ -51,8 +51,12 @@ $(addsuffix .test,${PACKAGES}): %.test:
doc-html: all doc-html: all
@dune build @doc @dune build @doc
@./tezos-client -protocol PtCJ7pwoxe8JasnHY8YonnLYjcVHmhiARPJvqcC6VfHT5s8k8sY man -verbosity 3 -format html | sed "s/$HOME/\$HOME/g" > docs/api/tezos-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-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 @mkdir -p $$(pwd)/docs/_build/api/odoc
@rm -rf $$(pwd)/docs/_build/api/odoc/* @rm -rf $$(pwd)/docs/_build/api/odoc/*
@cp -r $$(pwd)/_build/default/_doc/* $$(pwd)/docs/_build/api/odoc/ @cp -r $$(pwd)/_build/default/_doc/* $$(pwd)/docs/_build/api/odoc/
@ -97,5 +101,6 @@ clean:
tezos-protocol-compiler \ tezos-protocol-compiler \
$(foreach p, $(active_protocol_versions), tezos-baker-$(p) tezos-endorser-$(p) tezos-accuser-$(p)) $(foreach p, $(active_protocol_versions), tezos-baker-$(p) tezos-endorser-$(p) tezos-accuser-$(p))
@-${MAKE} -C docs clean @-${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 .PHONY: all test build-deps docker-image clean

48
docs/api/cli-commands.rst
View File

@ -12,19 +12,55 @@ using the following shell commands.
tezos-admin-client man -verbosity 3 tezos-admin-client man -verbosity 3
.. _tezos_client_commands: .. _client_manual:
Command line client Client manual
=================== =============
.. raw:: html .. raw:: html
:file: tezos-client.html :file: tezos-client.html
.. _tezos_admin_client_commands: .. _admin_client_manual:
Administration command line client Admin-client manual
================================== ===================
.. raw:: html .. raw:: html
:file: tezos-admin-client.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