Open charlesdaniels opened 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.
Looks like Read the Docs accepts markdown
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.
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.