]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
improved appendices, included man pages to ARM, more cleanups
authorMichal Nowikowski <godfryd@isc.org>
Thu, 18 Jul 2019 06:50:12 +0000 (08:50 +0200)
committerMichal Nowikowski <godfryd@isc.org>
Tue, 30 Jul 2019 08:45:13 +0000 (10:45 +0200)
doc/Makefile.am
doc/sphinx/.gitignore
doc/sphinx/Makefile.am
doc/sphinx/arm/STYLEGUIDE [deleted file]
doc/sphinx/arm/acknowledgments.rst [new file with mode: 0644]
doc/sphinx/arm/index.rst
doc/sphinx/arm/manpages.rst [new file with mode: 0644]
doc/sphinx/man/kea-shell.8.rst

index ad4b93775ccbbda0e96605d62180892aafd22412..f1222e332066acd26c7508f748217249f51b1de4 100644 (file)
@@ -1,5 +1,7 @@
 SUBDIRS = devel sphinx
 
+EXTRA_DIST += images/kea-logo-100x70.png
+
 nobase_dist_doc_DATA  = examples/agent/comments.json
 nobase_dist_doc_DATA += examples/agent/simple.json
 nobase_dist_doc_DATA += examples/ddns/comments.json
index 9b4cbefcd5676dadec1a896b87e16d1f65498790..183ae1dd8b141c77267bd0f989a83afe694291d8 100644 (file)
@@ -1 +1,3 @@
+/_build
 /kea-messages.rst
+
index 59fe3d1d6f83fc38645811d96dc4b18c4afd2184..a1a3c895e1776d629ae3f82bc03d1b6d9664e433 100644 (file)
@@ -53,7 +53,7 @@ rst_arm_sources+=arm/quickstart.rst
 rst_arm_sources+=arm/shell.rst
 rst_arm_sources+=arm/stats.rst
 
-main_sources=$(rst_arm_sources) kea-messages.rst conf.py $(static_sources)
+main_sources=$(rst_arm_sources) conf.py $(static_sources)
 
 # mans
 rst_man_sources=
@@ -114,10 +114,10 @@ kea-messages.rst: $(mes_files) system_messages.py
        $(srcdir)/system_messages.py -o $@ $(mes_files)
 
 
-pdf: $(main_sources)
+pdf: $(main_sources) kea-messages.rst
        $(SPHINXBUILD) -M latexpdf $(srcdir) $(sphinxbuilddir) $(sphinxopts)
 
-html: $(main_sources)
+html: $(main_sources) kea-messages.rst
        $(SPHINXBUILD) -M html $(srcdir) $(sphinxbuilddir) $(sphinxopts)
 
 $(man8s): mans
diff --git a/doc/sphinx/arm/STYLEGUIDE b/doc/sphinx/arm/STYLEGUIDE
deleted file mode 100644 (file)
index 76a2dee..0000000
+++ /dev/null
@@ -1,7 +0,0 @@
-This document will cover rules and suggestions for writing
-and editing the BIND 10 guide.
-
-Use alphabetical order for options and configuration syntax
-sorting unless you have a specific reason not to.
-
-TODO: list the docbook tags to be used for specific things here
diff --git a/doc/sphinx/arm/acknowledgments.rst b/doc/sphinx/arm/acknowledgments.rst
new file mode 100644 (file)
index 0000000..66f973f
--- /dev/null
@@ -0,0 +1,33 @@
+Acknowledgments
+===============
+
+Kea is an open source project designed, developed, and maintained by
+Internet Systems Consortium, Inc, a 501(c)3 non-profit organization. ISC
+is primarily funded by revenues from support subscriptions for our open
+source, and we encourage all professional users to consider this option.
+To learn more, see \ https://www.isc.org/support/.
+
+If you would like to contribute to ISC to assist us in continuing to
+make quality open source software, please visit our donations page at
+\ https://www.isc.org/donate/.
+
+We thank all the organizations and individuals who have helped to make
+Kea possible. `Comcast <https://www.comcast.com/>`__ and the Comcast
+Innovation Fund provided major support for the development of Kea's
+DHCPv4, DHCPv6, and DDNS modules. Mozilla funded initial work on the
+REST API via a MOSS award.
+
+Kea was initially implemented as a collection of applications within the
+BIND 10 framework. We thank the founding sponsors of the BIND 10
+project: `Afilias <https://www.afilias.info/>`__,
+`IIS.SE <https://www.iis.se/>`__,
+`Nominet <https://www.nominet.uk/>`__,
+`SIDN <https://www.sidn.nl/>`__, `JPRS <https://jprs.co.jp/>`__,
+`CIRA <https://cira.ca/>`__; and additional sponsors
+`AFNIC <https://www.afnic.fr/>`__,
+`CNNIC <https://www.cnnic.net.cn/>`__, `CZ.NIC <https://www.nic.cz/>`__,
+`DENIC eG <https://www.denic.de/>`__,
+`Google <https://www.google.com/>`__, `RIPE
+NCC <https://www.ripe.net/>`__, `Registro.br <https://registro.br/>`__,
+`.nz Registry Services <https://nzrs.net.nz/>`__, and `Technical Center
+of Internet <https://www.tcinet.ru/>`__.
index b974123f6ff33ddb3ead4d9292c8a70aeb18b4ba..4c06f20df6d837b7e80bee8fff3378706eb56400 100644 (file)
@@ -39,45 +39,16 @@ Kea, can be found in ISC's `Knowledgebase <https://kb.isc.org/docs/kea-administr
    logging
    shell
    netconf
-   api
-
-TODO: this is appendix
-
-Acknowledgments
-===============
-
-Kea is an open source project designed, developed, and maintained by
-Internet Systems Consortium, Inc, a 501(c)3 non-profit organization. ISC
-is primarily funded by revenues from support subscriptions for our open
-source, and we encourage all professional users to consider this option.
-To learn more, see \ https://www.isc.org/support/.
 
-If you would like to contribute to ISC to assist us in continuing to
-make quality open source software, please visit our donations page at
-\ https://www.isc.org/donate/.
-
-We thank all the organizations and individuals who have helped to make
-Kea possible. `Comcast <https://www.comcast.com/>`__ and the Comcast
-Innovation Fund provided major support for the development of Kea's
-DHCPv4, DHCPv6, and DDNS modules. Mozilla funded initial work on the
-REST API via a MOSS award.
+.. toctree::
+   :caption: Appendices
+   :name: appendices
+   :maxdepth: 1
 
-Kea was initially implemented as a collection of applications within the
-BIND 10 framework. We thank the founding sponsors of the BIND 10
-project: `Afilias <https://www.afilias.info/>`__,
-`IIS.SE <https://www.iis.se/>`__,
-`Nominet <https://www.nominet.uk/>`__,
-`SIDN <https://www.sidn.nl/>`__, `JPRS <https://jprs.co.jp/>`__,
-`CIRA <https://cira.ca/>`__; and additional sponsors
-`AFNIC <https://www.afnic.fr/>`__,
-`CNNIC <https://www.cnnic.net.cn/>`__, `CZ.NIC <https://www.nic.cz/>`__,
-`DENIC eG <https://www.denic.de/>`__,
-`Google <https://www.google.com/>`__, `RIPE
-NCC <https://www.ripe.net/>`__, `Registro.br <https://registro.br/>`__,
-`.nz Registry Services <https://nzrs.net.nz/>`__, and `Technical Center
-of Internet <https://www.tcinet.ru/>`__.
+   api
+   acknowledgments
+   manpages
 
-.. |image0| image:: kea-logo-100x70.png
 
 
 
diff --git a/doc/sphinx/arm/manpages.rst b/doc/sphinx/arm/manpages.rst
new file mode 100644 (file)
index 0000000..362a990
--- /dev/null
@@ -0,0 +1,26 @@
+..
+   Copyright (C) Internet Systems Consortium, Inc. ("ISC")
+
+   This Source Code Form is subject to the terms of the Mozilla Public
+   License, v. 2.0. If a copy of the MPL was not distributed with this
+   file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+   See the COPYRIGHT file distributed with this work for additional
+   information regarding copyright ownership.
+
+.. _manpages:
+
+Manual Pages
+============
+
+.. include:: ../man/kea-shell.8.rst
+.. include:: ../man/kea-admin.8.rst
+.. include:: ../man/keactrl.8.rst
+.. include:: ../man/kea-ctrl-agent.8.rst
+.. include:: ../man/kea-dhcp4.8.rst
+.. include:: ../man/kea-dhcp6.8.rst
+.. include:: ../man/kea-dhcp-ddns.8.rst
+.. include:: ../man/kea-lfc.8.rst
+.. include:: ../man/kea-netconf.8.rst
+.. include:: ../man/kea-shell.8.rst
+.. include:: ../man/perfdhcp.8.rst
index 4c1f232b8273aa7b9c57f2e703d80302547c8893..deb51a2fd05a0b9d36d7cbec033a70c3fa7c46ff 100644 (file)
@@ -1,5 +1,3 @@
-:orphan:
-
 ..
    Copyright (C) Internet Systems Consortium, Inc. ("ISC")