Branch: refs/heads/main
Revision: 9834c383daff5f912fd7241081a43d5f54739ddc
Author: jabraham17
Link: Add chpldoc.noAutoInclude and chpldoc.noUsage by jabraham17 · Pull Request #28638 · chapel-lang/chapel · GitHub
Log Message:
Add chpldoc.noAutoInclude and chpldoc.noUsage (#28638)
Adds two new chpldoc attributes to better control the output
- chpldoc.noAutoInclude: suppress auto-including this generated rst in
the docs - chpldoc.noUsage: suppress the generated usage information, telling
users to "use ModuleName"
Additionally, rewrites the pragma for suppressing where clauses in docs
to use an attribute. However, its still undocumented.
Note to reviewer: many of the changes in conf.py can be ignored, they
are purely formatting. See
https://github.com/chapel-lang/chapel/pull/28638/changes/fb0f703f9b79ad9f0efe2941392561f73ff37c8f
- paratest
[Reviewed by @arifthpe]
Diff:
M doc/rst/conf.py
M doc/rst/tools/chpldoc/chpldoc.rst
M frontend/include/chpl/uast/PragmaList.h
M modules/internal/ChapelDomain.chpl
M modules/internal/ChapelRange.chpl
M modules/standard/Types.chpl
M test/chpldoc/functions/WhereClause.doc.chpl
A test/chpldoc/module/noUsage.doc.catfiles
A test/chpldoc/module/noUsage.doc.chpl
A test/chpldoc/module/noUsage.doc.good
A test/chpldoc/noAutoInclude/MyModule.doc.chpl
A test/chpldoc/noAutoInclude/MyModule.doc.chpldocopts
A test/chpldoc/noAutoInclude/MyModule.doc.good
A test/chpldoc/noAutoInclude/MyModule.doc.prediff
A test/chpldoc/noAutoInclude/MyOtherModule.chpl
A test/chpldoc/noAutoInclude/MyOtherModule.notest
A test/chpldoc/noAutoInclude/MySubModules.chpl
A test/chpldoc/noAutoInclude/MySubModules.notest
A test/chpldoc/noAutoInclude/MySubModules/SubA.chpl
A test/chpldoc/noAutoInclude/MySubModules/SubB.chpl
M third-party/chpl-venv/chpldoc-sphinx-project/source/conf.py
M tools/chpldoc/chpldoc.cpp
https://github.com/chapel-lang/chapel/pull/28638.diff