Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better generated index.rst #205

Open
Tracked by #206
ryanmrichard opened this issue Nov 23, 2021 · 0 comments
Open
Tracked by #206

Better generated index.rst #205

ryanmrichard opened this issue Nov 23, 2021 · 0 comments
Labels
good first issue Good for newcomers

Comments

@ryanmrichard
Copy link
Member

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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ryanmrichard