Let more people know about NumSharp

[Oceania2018]

I've written an article here which introduce NumSharp.

@dotChris90 Can you start with the docs.

[dotChris90]

Would start maybe at weekends. Next 2 days have little bit more work to do. :)

[dotChris90]

@Oceania2018 just one little thing. Sorry I mention it.

Shouldn't it be:

var a = np.arange(9).Reshape(3,3)?

So with capital R instead of small r?
The output of arange is a NDArray object. So we call its Reshape method.

What we are doing is method chaining. So we do not use the np.reshape method (if exist didn't look ^^') but the NDArray Reshape method.

[dotChris90]

@Oceania2018 and question : shall we start doc with python sphinx? Or maybe take docfx? https://dotnet.github.io/docfx/

Just idk if sphinx can parse c# for api documentations by doc comments.

[Oceania2018]

We should use both of them, docfx is for generating md files, Sphinx is for organizing them, and make docs readable on readthedocs.io.

I prefer arange().reshape(), keep same as numpy as much as possible.

[dotChris90]

@Oceania2018 at the moment I experiment with docfx - it does not look as bad as i though. Especially the API documentation and the style looks promising. Moreover docfx is the one which is used from Microsoft I though. The hosting we could do on Github Pages.

Just feel annoyed at sphinx python doc, that it highlight my C# code but it thinks it is python lol so the code looks not good. And was investigating for C# docs at moment.

How you think of docfx? i tried at https://dotchris90.github.io/NumSharp/ I will not merge it to Scisharp/NumSharp - so dont worry but I will see how well this can look like.

[Oceania2018]

Does docfx generate markdown file? I think docfx is used to generate developer's API reference, because it is generated from souce code directly. Sphinx is often used to make tutorial document, like quick start. Sphinx support markdown file, it's easy to use.

[dotChris90]

Yes they are now able to do it. I was also surprised. Seems they developed quite well.

You can write so called articles which is equivalent sphinx tutorials. Using markdown. Very easy seems. So tutorials and api and swagger rest api and more seems (ok rest API is not important for us....).

I can maybe experiment with it and upload to my repo. If we think it looks good we can go with it. If not we take sphinx.

[dotChris90]

@Oceania2018 an example for our api
https://dotchris90.github.io/NumSharp/api/NumSharp.NDArray-1.html

And example for article :
https://dotchris90.github.io/NumSharp/articles/NDArray.Creation.html

@Oceania2018 if u not too angry with me. I would like to go with docfx. They plan to support multiple languages besides c# in future and using 100% md for articles. Plus the generated docs folder can be hosted 100% on github for free.

The only thing that I am not satisfied is... The style. I look now for better template...

[Oceania2018]

@dotChris90 Docfx looks awesome. keep going.

[dotChris90]

@Oceania2018 thanks. Before thinking about pull requests. Is NumSharps github page active? If not, could you activate it? Not sure if I can since u the founder / constructor of SciSharp organizations. :)

[Oceania2018]

@dotChris90 It's active. https://scisharp.github.io/NumSharp/

[dotChris90]

@Oceania2018 thanks a lot. Then today maybe write some more user tutorials. ;)
And push.