Restructure includes for ARM chapters 1 (Intro) and 2 (Requirements)

We have had perpetual problem with Sphinx implicitly double-including
files. To avoid that problem all files with name suffix .inc.rst are now
ignored by Sphinx, and writter can conveniently include them without
modifying conf.py for each and every file.

(cherry picked from commit 1322372a0c)
This commit is contained in:
Petr Špaček
2022-03-16 10:49:17 +01:00
parent f100a34b0e
commit 90c5127f2a
21 changed files with 55 additions and 39 deletions

View File

@@ -2,29 +2,32 @@ include $(top_srcdir)/Makefile.top
include $(top_srcdir)/Makefile.docs
EXTRA_DIST = \
conf.py \
isc-logo.pdf \
advanced.rst \
build.rst \
catz.rst \
build.inc.rst \
catz.inc.rst \
chapter1.rst \
chapter2.rst \
configuration.rst \
dlz.rst \
conf.py \
dlz.inc.rst \
dnssec-guide.rst \
dnssec.rst \
dyndb.rst \
dnssec.inc.rst \
dyndb.inc.rst \
general.rst \
history.rst \
index.rst \
introduction.rst \
logging-categories.rst \
managed-keys.rst \
introduction.inc.rst \
isc-logo.pdf \
logging-categories.inc.rst \
managed-keys.inc.rst \
manpages.rst \
notes.rst \
pkcs11.rst \
platforms.rst \
plugins.rst \
pkcs11.inc.rst \
platforms.inc.rst \
plugins.inc.rst \
reference.rst \
requirements.rst \
requirements.inc.rst \
requirements.txt \
security.rst \
troubleshooting.rst \
../dnssec-guide \

View File

@@ -779,12 +779,12 @@ according to its parent, should have been secure.
response; parent indicates it should be secure."
.. include:: dnssec.rst
.. include:: managed-keys.rst
.. include:: pkcs11.rst
.. include:: dlz.rst
.. include:: dyndb.rst
.. include:: catz.rst
.. include:: dnssec.inc.rst
.. include:: managed-keys.inc.rst
.. include:: pkcs11.inc.rst
.. include:: dlz.inc.rst
.. include:: dyndb.inc.rst
.. include:: catz.inc.rst
.. _ipv6:

12
doc/arm/chapter1.rst Normal file
View File

@@ -0,0 +1,12 @@
.. Copyright (C) Internet Systems Consortium, Inc. ("ISC")
..
.. SPDX-License-Identifier: MPL-2.0
..
.. 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 https://mozilla.org/MPL/2.0/.
..
.. See the COPYRIGHT file distributed with this work for additional
.. information regarding copyright ownership.
.. include:: introduction.inc.rst

14
doc/arm/chapter2.rst Normal file
View File

@@ -0,0 +1,14 @@
.. Copyright (C) Internet Systems Consortium, Inc. ("ISC")
..
.. SPDX-License-Identifier: MPL-2.0
..
.. 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 https://mozilla.org/MPL/2.0/.
..
.. See the COPYRIGHT file distributed with this work for additional
.. information regarding copyright ownership.
.. include:: requirements.inc.rst
.. include:: platforms.inc.rst
.. include:: build.inc.rst

View File

@@ -142,18 +142,7 @@ exclude_patterns = [
'_build',
'Thumbs.db',
'.DS_Store',
'*.grammar.rst',
'*.zoneopts.rst',
'build.rst',
'catz.rst',
'dlz.rst',
'dnssec.rst',
'dyndb.rst',
'logging-categories.rst',
'managed-keys.rst',
'pkcs11.rst',
'platforms.rst',
'plugins.rst'
'*.inc.rst'
]
# The master toctree document.

View File

@@ -312,4 +312,4 @@ described in the following table. These signals can be sent using the
| ``SIGINT`` | Causes the server to clean up and exit. |
+--------------+-------------------------------------------------------------+
.. include:: plugins.rst
.. include:: plugins.inc.rst

View File

@@ -17,8 +17,8 @@ BIND 9 Administrator Reference Manual
:numbered:
:maxdepth: 2
introduction
requirements
chapter1
chapter2
configuration
reference
advanced

View File

@@ -760,7 +760,7 @@ The following are the available categories and brief descriptions of the
types of log information they contain. More categories may be added in
future BIND releases.
.. include:: logging-categories.rst
.. include:: logging-categories.inc.rst
.. _query_errors:

View File

@@ -70,5 +70,3 @@ much memory or CPU power as in the first alternative, but this has the
disadvantage of making many more external queries, as none of the name
servers share their cached data.
.. include:: platforms.rst
.. include:: build.rst

View File

@@ -19,7 +19,7 @@ list1=$(
sort -u
)
list2=$(
sed -ne 's/^``\(.*\)``/\1/p' doc/arm/logging-categories.rst |
sed -ne 's/^``\(.*\)``/\1/p' doc/arm/logging-categories.inc.rst |
sort -u
)
status=0