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

[#745] Make grammar now has --markdown enabled

Browse Source
This commit is contained in:
Tomek Mrugalski 2021-06-22 15:29:19 +02:00
parent fa370bd2c8
commit 482ccf2e15
2 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/Makefile.am
View File

@ -79,11 +79,11 @@ grammar:
if GENERATE_DOCS
if GENERATE_PARSER
mkdir -p $(abs_top_srcdir)/doc/sphinx/grammar
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/dhcp4/dhcp4_parser > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-dhcp4-parser.txt
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/dhcp6/dhcp6_parser > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-dhcp6-parser.txt
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/d2/d2_parser > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-d2-parser.txt
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/agent/agent_parser > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-ca-parser.txt
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/netconf/netconf_parser > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-netconf-parser.txt
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/dhcp4/dhcp4_parser --markdown > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-dhcp4-parser.rst
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/dhcp6/dhcp6_parser --markdown > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-dhcp6-parser.rst
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/d2/d2_parser --markdown > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-d2-parser.rst
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/agent/agent_parser --markdown > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-ca-parser.rst
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/netconf/netconf_parser --markdown > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-netconf-parser.rst
else
@echo "ERROR: You need to enable both docs (--enable-generate-docs) and parser (--enable-generate-parser)"
@echo "ERROR: to regenerate grammar documentation."

12
doc/sphinx/grammar/grammar.rst
View File

@ -18,26 +18,24 @@ Here's the Backus-Naur form (BNF) https://en.wikipedia.org/wiki/Backus%E2%80%93N
BNF Grammar for DHCPv4
----------------------
```
.. include:: grammar-dhcp4-parser.txt
```
.. include:: grammar-dhcp4-parser.rst
BNF Grammar for DHCPv6
----------------------
.. include:: grammar-dhcp6-parser.txt
.. include:: grammar-dhcp6-parser.rst
BNF Grammar for Control Agent
-----------------------------
.. include:: grammar-ca-parser.txt
.. include:: grammar-ca-parser.rst
BNF Grammar for D2 (DHCP-DDNS)
------------------------------
.. include:: grammar-d2-parser.txt
.. include:: grammar-d2-parser.rst
BNF Grammar for Kea-netconf
---------------------------
.. include:: grammar-netconf-parser.txt
.. include:: grammar-netconf-parser.rst