Add tutorials with examples to Documentation #132
Conversation
This change also includes the fixes for currently missing documentation and crate level documentation.
Earlier to this change, documentation was generated using the command `cargo doc`. However, this has one drawback - when external markdown files were used, additional set of commands had to be run using `rustdoc` tool to generate the html files corresponding to the md files. With this change, `generate_docs.sh` bash script will handle those intricacies of running `cargo doc` followed by execution of `rustdoc` for external md files. This change adds the following tutorials to the documetation. * Getting Started with ArrayFire * Introduction to Vectorization * Array and Matrix Manipulation * Indexing * Configure ArrayFire Environment
|
@mlloreda @pavanky @jramapuram Feedback ? |
|
|
||
| Below we provide several examples of these functions and their use. | ||
|
|
||
| ### moddims() |
There was a problem hiding this comment.
Probably a stupid question: but isn't this already in the rust generated docs?
There was a problem hiding this comment.
That is true, but having these collected set of examples in one location is probably a good place to start for beginners and they can dwell into parameter documentation and additional examples in the hyperlinked function documentation page - at least that is how I picture it in the long run. I do agree that more examples in each function doc page are to be added yet.
There was a problem hiding this comment.
Yea, good point. Probably helpful as a reference for people getting started (before they have their setup/etc)
| Following are the list of environment and runtime configurations that will help enhance | ||
| your experience with ArrayFire. | ||
|
|
||
| # AF_PATH |
There was a problem hiding this comment.
This doc will definitely be helpful!
| @@ -0,0 +1,19 @@ | |||
| /* unvisited link */ | |||
| a:link { | |||
| color: #4d76ae; | |||
There was a problem hiding this comment.
Is all this going into the gh-pages? I tried your github.io for the fork but don't see anything.
There was a problem hiding this comment.
If you look at the generate_docs.sh that was added along with this change, that copies this new css file into the target/doc location while building the documentation.
| /// let garbageVals = Array::new_empty(Dim4::new(&[3, 1, 1, 1]), DType::F32); | ||
| /// ``` | ||
| #[allow(unused_mut)] | ||
| pub fn new_empty(dims: Dim4, aftype: DType) -> Array { |
There was a problem hiding this comment.
shouldn't this go into another PR?
There was a problem hiding this comment.
Sure, why not. Let me cherry pick that into separate PR. Ah, it's in the middle of other stuff, let's go ahead for now. I will make sure to separate such additions into separate PR's in future.
There was a problem hiding this comment.
It's not a big deal, just saying ;p
No description provided.