documentation work - Githubissues

EMS-TU-Ilmenau / fastmat

A library to build up lazily evaluated expressions of linear transforms for efficient scientific computing.

https://fastmat.readthedocs.io

Apache License 2.0

24 stars 8 forks source link

documentation work #66

Closed ChristophWWagner closed 4 years ago

ChristophWWagner commented 5 years ago

Let's use this branch and PR to work on the remainind doc-related issues of the 0.2 milestone. In particular, #17 #53 #54

SebastianSemper commented 5 years ago

The things that come to my mind are:

have some rudimentary benchmark plots, which just compare numpy and fastmat for some simple scenarios. we can extend these down the road, once we maybe got some external feedback on those we then currently will have.
put the new and fresh logos in the _static/gfx/ folder and sprinkle them over the documentation.

SebastianSemper commented 5 years ago

I would also like to add, that we should somehow clean up the appearance on https://pypi.org/project/fastmat/

SebastianSemper commented 5 years ago

I now got the sidepanel working nicely. Now one has a dropdown menu for the classes and algorithms as well as the submodules.

Moreover, we now have the additional docu dependency sphiny-rdt-theme, which is readily available via pypi.

SebastianSemper commented 5 years ago

I added a trimmed down pypi.md based on our README.md, which will clean up out pypi appearance. Moreover I fixed a bug in the CSS file causing Chrome to not pixelate our logo.

SebastianSemper commented 5 years ago

I just deleted all demos since we will refactor them anyway but we keep them out of 0.2 for now, since they do not work anyway. It is not too bad, since at least every algorithm and every class have their own short docu example.

SebastianSemper commented 5 years ago

I added doc string templates to our core routines.

SebastianSemper commented 5 years ago

What else is there to do?

SebastianSemper commented 4 years ago

has been merged in v0.2. closing