Skip to content

docs: add custom attribution tutorial - #2245

Open
harshkumar18-bzz wants to merge 1 commit into
aboutcode-org:mainfrom
harshkumar18-bzz:codex/docs-custom-attribution-tutorial
Open

harshkumar18-bzz wants to merge 1 commit into
aboutcode-org:mainfrom
harshkumar18-bzz:codex/docs-custom-attribution-tutorial

Conversation

@harshkumar18-bzz

Copy link
Copy Markdown

Issues

Changes

  • Add an end-to-end tutorial for customizing the attribution HTML template through .scancode/templates/attribution.html.
  • Document the current Django template context (project, packages, and licenses) and show a small branding customization.
  • Explain archive layout, attribution download steps, troubleshooting, and the precedence of the Project Settings template.
  • Link the tutorial from the documentation overview and attribution output reference.

This follows the current implementation and avoids the invalid resources-based example proposed in the earlier, self-closed #1968.

Validation

  • doc8 --max-line-length 100 --ignore-path docs/_build/ --quiet docs/
  • Full Sphinx HTML build succeeds. The stricter warnings-as-errors run reaches and renders the new page; it reports only pre-existing/environment warnings for unavailable external intersphinx inventories and the existing undefined changelog label.

Checklist

  • I have read the contributing guidelines
  • I have linked an existing issue above
  • No unit test is needed for this documentation-only change
  • Every changed line was reviewed against the current implementation

AI assistance disclosure

OpenAI Codex was used to inspect the issue and related history, check the current implementation, draft the documentation change, run validation, and prepare this pull request.

Signed-off-by: harsh <rangerharsh88@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Generate attribution with custom template tutorial

1 participant