tree dbdbdbc62ff88cd8931550391255f311cc4a3b0d
parent c6f68ac5038b24a027b969dc1bf681a09f138da6
author Jordan Bayles <bayles.jordan@gmail.com> 1787265885 -0700
committer GitHub <noreply@github.com> 1787265885 -0700
gpgsig -----BEGIN PGP SIGNATURE-----
 
 wsFcBAABCAAQBQJqh4NdCRC1aQ7uu5UhlAAAIw0QAEg8tN1+/+0dwgTkuTD9rPew
 X4VCBXs/G9VJqSZaYouRmNb9EMsZahKdlkr+d7FYo70miecwZzkn5E5xcHrP5l3m
 T3/FgibeXDhvVbTTeQ4fxIDtBAohNNLTsEVmwTb65eyHktk0Dw/ilCXcNB9cnrKa
 Bq5KvacK5FnplRH2x7h8ChhLPcah9RnjfRBcwIW2riJt0/pnm6FQnPuDrbz9Otg8
 q2ukTPNZ6d0LlbNSHrbZtI8DHWKVBruyuXZ2W/Z2YxzZgesoJin5lZ6VigbFX9Sb
 ZolurrDiX32ZYSsDQEzaYYO/jaJd7KDE2xwsaQSmYoRFlI48qEWjEwplcC8Kqcvq
 KKz1ugMSmBI7Oj3R0BKqAqLiQpNwn7sVtaEGlImrDSIbqlQW019lpD8a8Y8unVqY
 bap7VYis+ccLZnlfBSzvu0j6d63O+gsEPThoyncuKQWMPjM6fF5KJo6s8N2iZ+UZ
 0GY2jTC2FzoW5P7fMDvu3Zfqma/0s43xnUfihaxuz0y6+9xxNdjs7vsslsh7Ynv7
 jv+ev+ly2uvyQLeaRJJfaDaHs3qIlZfcOq4o2yx/zoF2TR+plZ1KN8mlSm0Bj+zr
 HukFaLgdY8cVcZ6nHGk9c7dlQOlAYgZlPoehF/3qyHLl2FYRgw+9rZ0sd+LUnI/l
 vc9zzPhi1LTIYrVcYTRB
 =1YsH
 -----END PGP SIGNATURE-----
 

docs: modernize doxygen build and publish from this repository (#1711)

* docs: modernize doxygen build and publish from this repository

The API docs were last published to the separate jsoncpp-docs repo in
January 2021 (for 1.9.4) and the local doxygen build has been broken
since the versioning rework removed the top-level `version` file.

Build fixes:
- doxybuild.py reads the version from include/json/version.h instead of
  a `version` file that CMake only generates in the build directory.
- doc/doxyfile.in is reduced to the non-default settings (the 2013-era
  1.8.5 template triggered 17 obsolete-tag warnings on current doxygen)
  and now sets WARN_AS_ERROR so documentation regressions fail the build.
- JSONCPP_DEPRECATED/JSON_API are stripped during preprocessing and
  __cplusplus=201703L is predefined, so deprecated members and the
  std::string_view overloads are documented.

Documentation fixes:
- reader.h / writer.h: a mismatched 'settings_` quote opened a backtick
  span that swallowed the rest of each header, leaving CharReaderBuilder
  and StreamWriterBuilder effectively undocumented.
- value.h: document the remaining parameters of Value::get and
  Value::removeMember.
- json_value.cpp: hide the private Value::CZString implementation from
  doxygen with \cond.

Output:
- Style with doxygen-awesome-css v2.4.2 (vendored, MIT) in place of the
  1.8.13-era header/footer templates; enable tree view and search.
- Use README.md as the main page; jsoncpp.dox becomes a "Quick start"
  page with the dead SourceForge links removed. Drop the 3-line roadmap
  stub and the redundant web_doxyfile.in.

Publishing:
- New docs workflow builds on pull requests (as a warning check) and
  deploys to GitHub Pages on pushes to master with a pinned,
  checksum-verified doxygen 1.18.0. README links now point at
  https://open-source-parsers.github.io/jsoncpp/.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs: pin workflow actions, drop fragile caller graphs

zizmor requires actions pinned to commit SHAs and persist-credentials
off. The caller graph for Json::Value::Value exceeded doxygen's node
limit in CI, which WARN_AS_ERROR turned into a failure; caller graphs of
the implementation add little to API docs, so drop them and leave
headroom in DOT_GRAPH_MAX_NODES for the remaining graphs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs: restrict Pages deploy to master, fix --tarball sources

workflow_dispatch from a non-master branch could previously publish that
branch's docs over the production site. The tarball list also still
referenced NEWS.txt and version, neither of which exists in the tree.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>