[Chapel Merge] docs(chpldoc): replace pragma 'no doc' with attribute

Notifications Commits
1

Branch: refs/heads/main
Revision: bd5e2509023df85f57a199e4d8d0d4728dcb8b49
Author: arezaii
Link: docs(chpldoc): replace pragma 'no doc' with attribute by arezaii · Pull Request #21915 · chapel-lang/chapel · GitHub
Log Message:
docs(chpldoc): replace pragma 'no doc' with attribute (#21915)

This PR updates the chpldoc documentation to change the method for
suppressing generated documentation from pragma "no doc" to
@chpldoc.nodoc.

This required changing the code block style from Chapel to plain text as
the sphinxcontrib-chapeldomain and pygments packages both require
updates to parse attributes.

Future work will change these back to Chapel blocks once those updated
packages are available.

TESTING:

  • build docs locally and inspect chpldoc page

reviewed by @lydia-duncan - thanks!

Compare: Comparing 2f7d9f5a3a3c6724e656ce5573ff76ca94471912...53d615fef6686781c8baf10eb7e50397c7239206 · chapel-lang/chapel · GitHub

Diff:
M doc/rst/tools/chpldoc/chpldoc.rst
https://github.com/chapel-lang/chapel/pull/21915.diff