ComputerSurge/bind9
3
0
Fork 0
Code Pull Requests 1 Activity
38,483 Commits 589 Branches 805 Tags
4b14bcedcfeca583bf08e192612b2db084607607
Commit Graph
5 Commits
Author SHA1 Message Date
Suzanne GoldlustandPetr Špaček 7e13992ee7 Add short description for plugin statement 
(cherry picked from commit d14828c5a7)
 2022-08-01 10:12:12 +02:00
Petr Špaček dba86ce710 Add hyperlinks to all unique statement names 
This shell script added hyperlinks to all unique statement names:

    UNIQSTATEMENTS=$(\
        sort \
            <(git grep '.. namedconf:statement::' '*.rst' | sed -e 's/^.*:: //') \
            <(git grep '.. rndcconf:statement::' '*.rst' | sed -e 's/^.*:: //') \
        | uniq --unique)
    ARMFILES=$(git ls-files 'doc/*.rst' | grep -v 'doc/man')
    for STATEMENT in $UNIQSTATEMENTS; \
        do sed -i -e "s/\`\`$STATEMENT\`\`/:any:\`$STATEMENT\`/g" $ARMFILES; \
    done

This needs manual cleanup (see next commit) to fix syntax errors.
 2022-07-04 16:08:59 +02:00
Petr Špaček 667335bd1c Add link anchors to statements and blocks in the ARM 
All statements now use .. namedconf:statement:: or
.. rndcconf:statement:: syntax provided by our Sphinx extension.

This has several consequences:
- It changes how statement headings are rendered
- Statements are indexed and show up as separate items in doc
  search results (in the HTML version)
- Statements can be linked to using either :any:`statement` or
  :namedconf:ref:`statement` syntax (not used in this commit)
- Statements can be categorized and printed using ..
  namedconf:statatementlist:: syntax (not used in this commit)

(cherry picked from commit e5b7022dcb)
 2022-06-24 16:47:25 +02:00
Ron AitchisonandPetr Špaček 8e49e918db Split Configuration chapter in the ARM into chapters 3 and 4 
(cherry picked from commit cd1c230ff6)
 2022-05-11 11:07:32 +02:00
Petr Špaček 90c5127f2a 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)
 2022-05-11 11:05:43 +02:00