search

charlesdaniels / bitshuffle

BSD 3-Clause "New" or "Revised" License
5 stars 0 forks source link

Stable public API #39

Open charlesdaniels opened 6 years ago

charlesdaniels commented 6 years ago

A stable API to use BitShuffle as a library needs to be designed, implemented, and documented.

As a component of this, the entire API should be tested by unit tests (which will constitute the completion of #5).

The documentation should be generated automatically, and we can host it on Read the Docs.

jyn514 commented 6 years ago

Looks like Read the Docs accepts markdown

charlesdaniels commented 6 years ago

Yes, I have succeeded in getting both Markdown and reST to co-exist in the same Sphinx wiki. All we would need is a build script.