search

laserson / squarify

Pure Python implementation of the squarify treemap layout algorithm
Other
297 stars 37 forks source link

create a dedicated page for the doc #38

Closed JosephBARBIERDARNAL closed 1 month ago

JosephBARBIERDARNAL commented 1 month ago

Hi!

I really like your package but I always have problems when I have to look for something in the documentation.

Would you be interested in having a dedicated project home page with the documentation? There are plenty of tools that make this easy enough and I'm willing to open a PR for it.

laserson commented 1 month ago

If you have a proposal for making the README clearer I would consider that, but otherwise I'm not interested in having a separate documentation site. The API is simple enough that I don't think that's necessary.

JosephBARBIERDARNAL commented 1 month ago

I've opened a draft #40 which adds margins between sections. IMO this makes the readme easier to read and is enough to "fix" the reason I opened this issue

laserson commented 1 month ago

Closing this issue in light of our discussion. I'll look out for an update to your PR.