Skip to content

Conversation

@bmtcril
Copy link
Contributor

@bmtcril bmtcril commented Dec 19, 2024

Description:

Finishes the ancient implementation of human readable reporting in rst and html. This should allow people to get a readable report from any well-configured annotation output without having to deal with Sphinx.

Closes: #128

Testing instructions:

  1. Create a code-annotations in any of the usual ways or use the one here: https://gist.github.com/bmtcril/0441b96e8cc92ba0c24b3178c4ef8e00
  2. See if the instructions in the getting_started and configuration docs are sufficient to help you configure and run the generate_docs command. A config that works with the gist above is included in that gist.
  3. Try viewing rst documents using restview (linked in the docs)
  4. Try viewing html document using a browser

Docs generate cleanly, should not throw errors when viewed, and should be relatively easy to follow. Links to github should work if configured.

restview screenshots:

Screenshot 2024-12-19 at 4 21 04 PM
Screenshot 2024-12-19 at 4 21 45 PM

HTML screenshots:

Screenshot 2024-12-19 at 4 22 09 PM
Screenshot 2024-12-19 at 4 22 39 PM

- Fixes broken links
- Includes default templates in built package
- Adds navigation for current page and all pages
- Indicates installed packages vs. local code
- Make generation timestamp more readable
@bmtcril bmtcril changed the title Bmtcril/finish rendering Simple local report rendering Dec 19, 2024
@saraburns1
Copy link

LGTM!

@bmtcril bmtcril merged commit 28debe3 into master Jan 16, 2025
9 checks passed
@bmtcril bmtcril deleted the bmtcril/finish_rendering branch January 16, 2025 18:26
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.

Complete work for rendering reports

3 participants