Arcadia-Science / arcadia-pycolor

tools for using the Arcadia palette in Python
MIT License
3 stars 0 forks source link

Reorganize docs and add a quickstart guide #33

Closed keithchev closed 1 week ago

keithchev commented 1 week ago

The documentation for the package currently consists of a series of jupyter notebooks. This PR:

Note: github does not recognize that the style_usage.ipynb notebook was moved; it treats it as a new file, so there's no way to view the diff, which is annoying. (I was careful to move the file in one commit and modify it in a second commit, so the git history "knows" about the renaming; this must be a github thing).

Other changes

Style changes

These were made in discussion with Dennis.

PR checklist

review-notebook-app[bot] commented 1 week ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

keithchev commented 1 week ago

@mezarque I made one minor change after you reviewed to add numpy as an explicit dependency. Since numpy was already a transitive dependency (of matplotlib), nothing was broken, but because some apc modules import numpy, it's good to include it among the direct deps.