Add ALDashboard to auto-documentation generation system #564
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds ALDashboard to the automatic documentation generation system for the Document Assembly Line documentation website. ALDashboard is a collection of tools for Docassemble server administration and interview debugging that was previously missing from the documentation ecosystem.
Changes Made
Documentation Generation Infrastructure
pydoc-markdown.yml
to include ALDashboard Python modules from../docassemble-ALDashboard/docassemble/
in the search pathdeploy.yml
andtest-deploy.yml
) to clone the ALDashboard repository during the documentation build processNavigation and Content
sidebars.js
under the "Assembly Line components" section/docs/components/ALDashboard/overview
covering:Cross-references
Testing
The changes have been thoroughly tested:
Auto-Generated API Documentation
The infrastructure is now in place for auto-generated API documentation from ALDashboard's Python modules. When the CI/CD environment has access to docassemble dependencies, pydoc-markdown will automatically generate detailed API documentation similar to other Assembly Line components.
Screenshots
Homepage showing proper navigation structure:

ALDashboard documentation page with full content and navigation:

Fixes #563.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.