mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 14:05:33 +00:00
Code Issues Releases Wiki Activity

[#2081] remove docbook and docgen mentions (extra)

Browse Source
This commit is contained in:
Andrei Pavel
2021-09-11 19:51:55 +03:00
committed by Tomek Mrugalski
parent 7ede1ced15
commit 91dd72dbf3
3 changed files with 15 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/devel/doc.dox
View File

@@ -11,27 +11,26 @@
There are several types of documentation for Kea. The primary one, intended to
be read by users, is User's Guide. It comes in HTML, PDF and txt format. All
of them generated from the same sources. To generate this doc, you need to
run configure script with --enable-generate-docs option. Several tools have to
be present in the system: docbook environment, links and several others.
run configure script with --enable-generate-docs option. sphinx has to be
enabled in the system.
You can generate this by doing:
@code
$ ./configure --enable-generate-docs
$ cd doc/
$ make guide
$ make -C ./doc
@endcode
The output files will be generated in doc/guide/ directory.
The output files will be generated in the ./doc/sphinx/_build directory.
Since Kea 1.5, this doc has appendix A that lists all Kea commands. That
appendix is generated using a small tool called docgen. The basic principle
The ARM has an appendix that lists all Kea commands. The commands are integrated
into RST using the tool located at doc/sphinx/api2doc.py. The basic principle
is that for every command there is a JSON file that briefly describes the major
aspects of the new command, such as name, short description, expected syntax,
expected response, a hook that needs to be loaded, first Kea version where it
appeared, etc. Those JSON files are loaded by docgen tool that will generate
api.xml that will be used by make guide. There is no need to generate this,
unless you alter description of existing commands or add a new one.
aspects such as name, short description, expected syntax, expected response,
a hook that needs to be loaded, first Kea version where it appeared, etc.
Those JSON files are loaded by the api2doc.py tool that will generate api.txt
that will be used by sphinx. There is no need to call this tool explicitly.
It is called automatically when building the ARM.
Since Kea 1.9.9, this doc has appendix with the grammar. If there were new
Since Kea 1.9.9, the ARM has an appendix with the grammar. If there were new
parameters added, you can regenerate the grammars and the appendix with the
following procedure: