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.

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

🐕🌭 Show some data-driven, reusable software documentation examples #45

Open
nrbgt opened this issue Nov 12, 2020 · 2 comments
Open

Comments

@nrbgt
Copy link
Contributor

nrbgt commented Nov 12, 2020

This project is (or will soon be) complex enough to show non-trivial demos of:

  • source code navigation
    • show a nested file treemap (sized by SLOC, etc.), click to view syntax-highlighted source
  • architecture diagrams
    • see how we're subclassing Widget, Box, etc.
  • automation processes
    • look at the doit graph
  • dependencies
    • see the fully resolved pip/conda relationships represented in lock files, etc.
  • profile information
    • call graph
  • widget linkages
  • test logs
    • show robot screenshots in plots

These would be cute to test, as we could take the generated SVG artifacts and put them in (eventual) documentation, but these seem like useful tools, especially for canonical outputs of common developer tools.

@dfreeman06
Copy link
Contributor

How does one grab the conda sat solver input constraints, i.e. resolve all of the numpy >=1.14,<1.19 through out the chain or maybe just the output of when conda can't solve for an environment?

I am thinking of the packages as nodes and the different ports being the version constraints. We might be able to have ports on the WEST being constraints and ports on the EAST being package releases.

This still might be too large or a diagram / number of edges to be useful but if we can show the conflicts that might be small enough to be meaningful.

@nrbgt
Copy link
Contributor Author

nrbgt commented Nov 19, 2020

Yeah, the SAT jumps up to 10k+ clauses really fast, and then manipulates them over a few passes. I think more like some of the mamba features, but not sure if they have a JSON data export, or just the ASCII art...

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

No branches or pull requests

2 participants