NWChemEx / NWChemEx/PluginPlay
Better generated index.rst
Open
Nobody has claimed this yet.
good first issue
- Dominant language
- C++
- Stars
- 13
- Forks
- 1
- Avg merge
- 43m
- Merged PRs (30d)
- 4
Description
The index.rst file generated by printing::document_modules should:
- have a title (my vote is
Module Documentation) - a brief intro paragraph explaining that the documentation was auto-generated by PluginPlay (hence serving as both a public service announcement that such functionality exists, and a warning that it will be overwritten the next time it's generated)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at printing::document_modules, where the generated index.rst content is assembled. Inspect the current generated structure, then ensure index.rst has the requested “Module Documentation” title and a brief explanation that PluginPlay generated it and regeneration will overwrite it. Done means both pieces appear in the generated output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100