Branch: refs/heads/main
Revision: 6ef09e8
Author: dlongnecke-cray
Log Message:
Merge pull request #18387 from dlongnecke-cray/next-add-doc-sections
next: Break up compiler/next docs into one page per namespace
This is for compiler/next
.
Add a subpage per namespace to the compiler-internals
section of
the documentation. For the base
section, which covers symbols in
the chpl
namespace, add important types by hand. Documentation
for symbols in nested namespaces is generated automatically by
Doxygen.
FUTURE WORK
- Get all classes to show up in the outline / sidebar
- Generate an index containing only C++ symbols
- Automatically generate types in
chpl
namespace - Expand macros before generating docs
Reviewed by @mppf. Thanks!
TESTING
- [x] Can build
chpl
- [x] Can build docs on Mac
- [x] Can build docs on Linux
- [x] Share rendered docs with reviewer
Signed-off-by: David Longnecker dlongnecke-cray@users.noreply.github.com
Modified Files:
A doc/templates/compiler-internals-doxygen/base.rst
A doc/templates/compiler-internals-doxygen/parsing.rst
A doc/templates/compiler-internals-doxygen/resolution.rst
A doc/templates/compiler-internals-doxygen/types.rst
A doc/templates/compiler-internals-doxygen/uast.rst
M doc/templates/compiler-internals-doxygen/index.rst
M doc/util/nitpick_ignore
Compare: https://github.com/chapel-lang/chapel/compare/7597c8660ada...6ef09e863dac