From: Michal Nowikowski Date: Thu, 18 Jul 2019 06:50:12 +0000 (+0200) Subject: improved appendices, included man pages to ARM, more cleanups X-Git-Tag: Kea-1.6.1~10^2~75 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=eb68de29b8fa7f4f4b706da9f53fafc37b083e32;p=thirdparty%2Fkea.git improved appendices, included man pages to ARM, more cleanups --- diff --git a/doc/Makefile.am b/doc/Makefile.am index ad4b93775c..f1222e3320 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -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 diff --git a/doc/sphinx/.gitignore b/doc/sphinx/.gitignore index 9b4cbefcd5..183ae1dd8b 100644 --- a/doc/sphinx/.gitignore +++ b/doc/sphinx/.gitignore @@ -1 +1,3 @@ +/_build /kea-messages.rst + diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am index 59fe3d1d6f..a1a3c895e1 100644 --- a/doc/sphinx/Makefile.am +++ b/doc/sphinx/Makefile.am @@ -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 index 76a2dee19a..0000000000 --- a/doc/sphinx/arm/STYLEGUIDE +++ /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 index 0000000000..66f973fa57 --- /dev/null +++ b/doc/sphinx/arm/acknowledgments.rst @@ -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 `__ 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 `__, +`IIS.SE `__, +`Nominet `__, +`SIDN `__, `JPRS `__, +`CIRA `__; and additional sponsors +`AFNIC `__, +`CNNIC `__, `CZ.NIC `__, +`DENIC eG `__, +`Google `__, `RIPE +NCC `__, `Registro.br `__, +`.nz Registry Services `__, and `Technical Center +of Internet `__. diff --git a/doc/sphinx/arm/index.rst b/doc/sphinx/arm/index.rst index b974123f6f..4c06f20df6 100644 --- a/doc/sphinx/arm/index.rst +++ b/doc/sphinx/arm/index.rst @@ -39,45 +39,16 @@ Kea, can be found in ISC's `Knowledgebase `__ 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 `__, -`IIS.SE `__, -`Nominet `__, -`SIDN `__, `JPRS `__, -`CIRA `__; and additional sponsors -`AFNIC `__, -`CNNIC `__, `CZ.NIC `__, -`DENIC eG `__, -`Google `__, `RIPE -NCC `__, `Registro.br `__, -`.nz Registry Services `__, and `Technical Center -of Internet `__. + 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 index 0000000000..362a9901a1 --- /dev/null +++ b/doc/sphinx/arm/manpages.rst @@ -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 diff --git a/doc/sphinx/man/kea-shell.8.rst b/doc/sphinx/man/kea-shell.8.rst index 4c1f232b82..deb51a2fd0 100644 --- a/doc/sphinx/man/kea-shell.8.rst +++ b/doc/sphinx/man/kea-shell.8.rst @@ -1,5 +1,3 @@ -:orphan: - .. Copyright (C) Internet Systems Consortium, Inc. ("ISC")