ElementsProject · rustyrussell · Aug 22, 2019 · Aug 9, 2019 · Aug 9, 2019 · Aug 9, 2019
diff --git a/.travis/build.sh b/.travis/build.sh
@@ -29,7 +29,7 @@ fi
 
 pyenv global 3.7.1
 pip3 install --user --quiet mako
-pip3 install --user --quiet -r tests/requirements.txt
+pip3 install --user --quiet -r tests/requirements.txt -r doc/requirements.txt
 pip3 install --quiet \
      pytest-test-groups==1.0.3
 

diff --git a/doc/Makefile b/doc/Makefile
@@ -30,6 +30,7 @@ MANPAGES := doc/lightning-cli.1 \
 	doc/lightning-listsendpays.7 \
 	doc/lightning-newaddr.7 \
 	doc/lightning-pay.7 \
+	doc/lightning-plugin.7 \
 	doc/lightning-sendpay.7 \
 	doc/lightning-setchannelfee.7 \
 	doc/lightning-txprepare.7 \
@@ -40,10 +41,10 @@ MANPAGES := doc/lightning-cli.1 \
 	doc/lightning-waitsendpay.7 \
 	doc/lightning-withdraw.7 
 
-doc-all: $(MANPAGES)
+doc-all: $(MANPAGES) doc/index.rst
 
-$(MANPAGES): doc/%: doc/%.txt
-	@if $(CHANGED_FROM_GIT); then echo a2x --format=manpage $<; a2x --format=manpage $<; else touch $@; fi
+$(MANPAGES): doc/%: doc/%.md
+	@if $(CHANGED_FROM_GIT); then echo mrkd $<; mrkd $<; else touch $@; fi
 
 doc/protocol-%.svg: test/test_protocol
 	test/test_protocol --svg < test/commits/$*.script > $@
@@ -78,8 +79,8 @@ clean: doc-clean
 check: check-manpages
 
 check-manpages: cli/lightning-cli lightningd/lightningd
-	@tools/check-manpage.sh cli/lightning-cli doc/lightning-cli.1.txt
-	@tools/check-manpage.sh "lightningd/lightningd --lightning-dir=/tmp/" doc/lightningd-config.5.txt
+	@tools/check-manpage.sh cli/lightning-cli doc/lightning-cli.1.md
+	@tools/check-manpage.sh "lightningd/lightningd --lightning-dir=/tmp/" doc/lightningd-config.5.md
 
 doc-maintainer-clean:
 	$(RM) doc/deployable-lightning.pdf
@@ -88,3 +89,7 @@ doc-maintainer-clean:
 doc-clean:
 	$(RM) doc/deployable-lightning.{aux,bbl,blg,dvi,log,out,tex}
 
+doc/index.rst:
+	(grep -v '^   lightning.*\.[0-9]\.md$$' $@; for m in $$(cd doc && ls lightning*.[0-9].md); do echo "   $$m"; done) > $@.tmp.$$$$ && mv $@.tmp.$$$$ $@
+
+.PHONY: doc/index.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -22,3 +22,44 @@ c-lightning Documentation
    Coding Style Guideline <STYLE.md>
    MAKING-RELEASES.md
    CHANGELOG.md
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Manpages
+
+   lightning-autocleaninvoice.7.md
+   lightning-check.7.md
+   lightning-cli.1.md
+   lightning-close.7.md
+   lightning-connect.7.md
+   lightningd.8.md
+   lightningd-config.5.md
+   lightning-decodepay.7.md
+   lightning-delexpiredinvoice.7.md
+   lightning-delinvoice.7.md
+   lightning-disconnect.7.md
+   lightning-fundchannel.7.md
+   lightning-fundchannel_cancel.7.md
+   lightning-fundchannel_complete.7.md
+   lightning-fundchannel_start.7.md
+   lightning-getroute.7.md
+   lightning-invoice.7.md
+   lightning-listchannels.7.md
+   lightning-listforwards.7.md
+   lightning-listfunds.7.md
+   lightning-listinvoices.7.md
+   lightning-listpays.7.md
+   lightning-listpeers.7.md
+   lightning-listsendpays.7.md
+   lightning-newaddr.7.md
+   lightning-pay.7.md
+   lightning-plugin.7.md
+   lightning-sendpay.7.md
+   lightning-setchannelfee.7.md
+   lightning-txdiscard.7.md
+   lightning-txprepare.7.md
+   lightning-txsend.7.md
+   lightning-waitanyinvoice.7.md
+   lightning-waitinvoice.7.md
+   lightning-waitsendpay.7.md
+   lightning-withdraw.7.md
diff --git a/doc/lightning-autocleaninvoice.7 b/doc/lightning-autocleaninvoice.7
@@ -1,55 +1,48 @@
-'\" t
-.\"     Title: lightning-autocleaninvoice
-.\"    Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 04/16/2018
-.\"    Manual: \ \&
-.\"    Source: \ \&
-.\"  Language: English
-.\"
-.TH "LIGHTNING\-AUTOCLEAN" "7" "04/16/2018" "\ \&" "\ \&"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el       .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-lightning-autocleaninvoice \- Set up auto\-delete of expired invoice
-.SH "SYNOPSIS"
-.sp
+.TH "LIGHTNING-AUTOCLEANINVOICE" "7" "" "" "lightning-autocleaninvoice"
+.SH NAME
+
+
+lightning-autocleaninvoice - Set up auto-delete of expired invoice
+
+.SH SYNOPSIS
+
 \fBautocleaninvoice\fR [\fIcycle_seconds\fR] [\fIexpired_by\fR]
-.SH "DESCRIPTION"
-.sp
-The \fBautocleaninvoice\fR RPC command sets up automatic cleaning of expired invoices\&.
-.sp
-Autoclean will be done every \fIcycle_seconds\fR seconds\&. Setting \fIcycle_seconds\fR to 0 disables autoclean\&. If not specified, this defaults to 3600 (one hour)\&.
-.sp
-Every autoclean cycle, expired invoices, which have already been expired for at least \fIexpired_by\fR seconds, will be deleted\&. If \fIexpired_by\fR is not specified, this defaults to 86400 (one day)\&.
-.sp
-On startup of the daemon, no autoclean is set up\&.
-.SH "RETURN VALUE"
-.sp
-On success, an empty object is returned\&.
-.SH "AUTHOR"
-.sp
-ZmnSCPxj <ZmnSCPxj@protonmail\&.com> is mainly responsible\&.
-.SH "SEE ALSO"
-.sp
-lightning\-delexpiredinvoice(7), lightning\-delinvoice(7)
-.SH "RESOURCES"
-.sp
-Main web site: https://github\&.com/ElementsProject/lightning
+
+.SH DESCRIPTION
+
+The \fBautocleaninvoice\fR RPC command sets up automatic cleaning of
+expired invoices\.
+
+
+Autoclean will be done every \fIcycle_seconds\fR seconds\. Setting
+\fIcycle_seconds\fR to 0 disables autoclean\. If not specified, this
+defaults to 3600 (one hour)\.
+
+
+Every autoclean cycle, expired invoices, which have already been expired
+for at least \fIexpired_by\fR seconds, will be deleted\. If \fIexpired_by\fR is
+not specified, this defaults to 86400 (one day)\.
+
+
+On startup of the daemon, no autoclean is set up\.
+
+.SH RETURN VALUE
+
+On success, an empty object is returned\.
+
+.SH AUTHOR
+
+ZmnSCPxj \fBNone\fR (\fI<ZmnSCPxj@protonmail.com\fR)> is mainly responsible\.
+
+.SH SEE ALSO
+
+\fBlightning-delexpiredinvoice\fR(7), \fBlightning-delinvoice\fR(7)
+
+.SH RESOURCES
+
+Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
+
+.HL
+
+Last updated 2019-04-07 14:23:17 CEST
+
diff --git a/doc/lightning-autocleaninvoice.7.md b/doc/lightning-autocleaninvoice.7.md
@@ -0,0 +1,48 @@
+LIGHTNING-AUTOCLEANINVOICE(7) Manual Page
+=========================================
+lightning-autocleaninvoice - Set up auto-delete of expired invoice
+
+SYNOPSIS
+--------
+
+**autocleaninvoice** \[*cycle\_seconds*\] \[*expired\_by*\]
+
+DESCRIPTION
+-----------
+
+The **autocleaninvoice** RPC command sets up automatic cleaning of
+expired invoices.
+
+Autoclean will be done every *cycle\_seconds* seconds. Setting
+*cycle\_seconds* to 0 disables autoclean. If not specified, this
+defaults to 3600 (one hour).
+
+Every autoclean cycle, expired invoices, which have already been expired
+for at least *expired\_by* seconds, will be deleted. If *expired\_by* is
+not specified, this defaults to 86400 (one day).
+
+On startup of the daemon, no autoclean is set up.
+
+RETURN VALUE
+------------
+
+On success, an empty object is returned.
+
+AUTHOR
+------
+
+ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible.
+
+SEE ALSO
+--------
+
+lightning-delexpiredinvoice(7), lightning-delinvoice(7)
+
+RESOURCES
+---------
+
+Main web site: <https://github.com/ElementsProject/lightning>
+
+------------------------------------------------------------------------
+
+Last updated 2019-04-07 14:23:17 CEST
diff --git a/doc/lightning-autocleaninvoice.7.txt b/doc/lightning-autocleaninvoice.7.txt
diff --git a/doc/lightning-check.7 b/doc/lightning-check.7
@@ -1,52 +1,44 @@
-'\" t
-.\"     Title: lightning-check
-.\"    Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 12/07/2018
-.\"    Manual: \ \&
-.\"    Source: \ \&
-.\"  Language: English
-.\"
-.TH "LIGHTNING\-CHECK" "7" "12/07/2018" "\ \&" "\ \&"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el       .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-lightning-check \- Command for verifying parameters\&.
-.SH "SYNOPSIS"
-.sp
+.TH "LIGHTNING-CHECK" "7" "" "" "lightning-check"
+.SH NAME
+
+
+lightning-check - Command for verifying parameters
+
+.SH SYNOPSIS
+
 \fBcheck\fR \fIcommand_to_check\fR [\fIparameters\fR]
-.SH "DESCRIPTION"
-.sp
-The \fBcheck\fR command verifies another command\(cqs parameters without running it\&.
-.sp
-The \fIcommand_to_check\fR is the name of the relevant command\&.
-.sp
-\fIparameters\fR is the command\(cqs parameters\&.
-.sp
-This does not guarantee successful execution of the command in all cases\&. For example, a call to \fBgetroute\fR may still fail to find a route even if checking the parameters succeeds\&.
-.SH "RETURN VALUE"
-.sp
-On success, the \fIcommand_to_check\fR is returned\&. On failure, the relevant RPC error is returned\&.
-.SH "AUTHOR"
-.sp
-Mark Beckwith <wythe@intrig\&.com> and Rusty Russell <rusty@rustcorp\&.com\&.au> are mainly responsible\&.
-.SH "RESOURCES"
-.sp
-Main web site: https://github\&.com/ElementsProject/lightning
+
+.SH DESCRIPTION
+
+The \fBcheck\fR RPC command verifies another command’s parameters without
+running it\.
+
+
+The \fIcommand_to_check\fR is the name of the relevant command\.
+
+
+\fIparameters\fR is the command’s parameters\.
+
+
+This does not guarantee successful execution of the command in all
+cases\. For example, a call to \fBlightning-getroute\fR(7) may still fail to
+find a route even if checking the parameters succeeds\.
+
+.SH RETURN VALUE
+
+On success, the \fIcommand_to_check\fR is returned\. On failure, the
+relevant RPC error is returned\.
+
+.SH AUTHOR
+
+Mark Beckwith \fBNone\fR (\fI<wythe@intrig.com\fR)> and Rusty Russell
+\fBNone\fR (\fI<rusty@rustcorp.com.au\fR)> are mainly responsible\.
+
+.SH RESOURCES
+
+Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
+
+.HL
+
+Last updated 2019-04-30 17:12:10 CEST
+