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

Document the repo-maintenance repository #194

Closed
3 tasks done
Tracked by #175
redeboer opened this issue Oct 6, 2023 · 0 comments · Fixed by ComPWA/compwa.github.io#214
Closed
3 tasks done
Tracked by #175

Document the repo-maintenance repository #194

redeboer opened this issue Oct 6, 2023 · 0 comments · Fixed by ComPWA/compwa.github.io#214
Assignees
@redeboer
Labels
📝 Docs Improvements or additions to documentation

Comments

@redeboer
Copy link
Member

redeboer commented Oct 6, 2023 •
edited
Loading

The ComPWA/repo-maintenance is getting a more central role since #175: it serves as a tool to synchronize developer settings among all ComPWA repositories. It should be relatively easy to document the existing codebase with sphinx.ext.autodoc and host it with GitHub Pages.

Implementation
Preview Give feedback
  1. DOC: host API documentation for repoma module repo-maintenance#193
    📝 Docs
    redeboer
  2. DOC: automatically document check-dev-files arguments repo-maintenance#195
    📝 Docs 🖱️ DX
    redeboer
  3. DOC: add links to ComPWA/repo-maintenance compwa-org#214
    📝 Docs
    redeboer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@redeboer redeboer

Labels
📝 Docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: add links to ComPWA/repo-maintenance redeboer/compwa.github.io
1 participant
@redeboer