joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-26 17:26:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Dev Docs: Put RPC Tables In Separate CSS Class

Browse source 
Suggested by Saivann: RPC tables with Name/Type/Presence/Description
format are now in .ntpd CSS class so that we can format them specially.

We also change the style of all dev doc tables to replace bold table
headings (thead) with a double-line border-bottom.  This makes the
theads look less like section headings and prevents us from over-using
bold.

Minor: a Makefile warning message has been made more explicit (also
suggested by Saivann) and another Makefile rule was updated to catch
more broken tables.
This commit is contained in:
David A. Harding 2014-12-30 01:11:26 -05:00
parent b8abfb2dcd
commit 9329c69cf8
No known key found for this signature in database
GPG key ID: 4B29C30FF29EC4B7
83 changed files with 209 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Makefile
View file

@ -122,7 +122,7 @@ check-for-broken-kramdown-tables:
## Kramdown tables are easy to break. When broken, they produce a
## paragraph starting with a | (pipe). I can't imagine any reason we'd
## have a regular paragraph starting with a pipe, so error on any occurences.
$S grep '<p>|' _site/en/developer-* | eval $(ERROR_ON_OUTPUT)
$S grep '<p[^>]*>|' _site/en/developer-* | eval $(ERROR_ON_OUTPUT)
check-for-duplicate-header-ids:
@ -170,7 +170,8 @@ check-for-missing-rpc-summaries:
## Make sure the Quick Reference section has a summary for each RPC we
## have documented
$S for f in _includes/ref/bitcoin-core/rpcs/rpcs/*.md ;\
do grep -q "\[$$( grep '^##### ' $$f | sed 's/^##### *\([a-zA-Z]*\).*/\1/')\]\[" _includes/ref/bitcoin-core/rpcs/quick-ref.md || echo "missing summary for $$f" \
do grep -q "\[$$( grep '^##### ' $$f | sed 's/^##### *\([a-zA-Z]*\).*/\1/')\]\[" _includes/ref/bitcoin-core/rpcs/quick-ref.md \
|| echo 'missing summary for '$$f', you need to add the summary to _includes/ref/bitcoin-core/rpcs/quick-ref.md and run make manual-updates' \
; done | eval $(ERROR_ON_OUTPUT)
manual-update-summaries-file: