Merge pull request #2280 from AntoinePrv/doc-improvement-c

Documentation improvement Part #C

Author: JohanMabille

docs/source/adaptor.rst

@@ -20,8 +20,8 @@ The following example shows how to bring an ``std::vector`` into the expression
 
     #include <cstddef>
     #include <vector>
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xadapt.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xadapt.hpp>
 
     std::vector<double> v = {1., 2., 3., 4., 5., 6. };
     std::vector<std::size_t> shape = { 2, 3 };
@@ -50,7 +50,7 @@ ownership of the array:
 .. code::
 
     #include <cstddef>
-    #include "xtensor/xadapt.hpp"
+    #include <xtensor/xadapt.hpp>
 
     void compute(double* data, std::size_t size)
     {
@@ -82,8 +82,8 @@ the ownership of the array, meaning it will be deleted when the adaptor is destr
 .. code::
 
     #include <cstddef>
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xadapt.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xadapt.hpp>
 
     void compute(double*& data, std::size_t size)
     {
@@ -119,8 +119,8 @@ adaptor before calling ``compute`` and pass it to the function:
 .. code::
 
     #include <cstddef>
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xadapt.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xadapt.hpp>
 
     template <class A>
     void compute(A& a)
@@ -154,8 +154,8 @@ Adapting C arrays allocated on the stack is as simple as adapting ``std::vector`
 
     #include <cstddef>
     #include <vector>
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xadapt.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xadapt.hpp>
 
     double v[6] = {1., 2., 3., 4., 5., 6. };
     std::vector<std::size_t> shape = { 2, 3 };

docs/source/container.rst

@@ -29,7 +29,7 @@ The following example shows how to initialize a multi-dimensional array of dynam
 .. code::
 
     #include <vector>
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
 
     std::vector<size_t> shape = { 3, 2, 4 };
     std::vector<size_t> strides = { 8, 4, 1 };
@@ -40,7 +40,7 @@ However, this requires to carefully compute the strides to avoid buffer overflow
 .. code::
 
     #include <vector>
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
 
     std::vector<size_t> shape = { 3, 2, 4 };
     xt::xarray<double, xt::layout_type::dynamic> a(shape, xt::layout_type::row_major);
@@ -50,7 +50,7 @@ If the layout of the array can be fixed at compile time, we can make it even sim
 .. code::
 
     #include <vector>
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
 
     std::vector<size_t> shape = { 3, 2, 4 };
     xt::xarray<double, xt::layout_type::row_major> a(shape);
@@ -75,7 +75,7 @@ Let's use ``xtensor`` instead of ``xarray`` in the previous example:
 .. code::
 
     #include <array>
-    #include "xtensor/xtensor.hpp"
+    #include <xtensor/xtensor.hpp>
 
     std::array<size_t, 3> shape = { 3, 2, 4 };
     xt::xtensor<double, 3> a(shape);
@@ -86,7 +86,7 @@ Or when using ``xtensor_fixed``:
 
 .. code::
 
-    #include "xtensor/xfixed.hpp"
+    #include <xtensor/xfixed.hpp>
 
     xt::xtensor_fixed<double, xt::xshape<3, 2, 4>> a();
     // or xt::xtensor_fixed<double, xt::xshape<3, 2, 4>, xt::layout_type::row_major>()
@@ -107,7 +107,7 @@ compatible with the old one, that is, the number of elements in the container mu
 
 .. code::
 
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
 
     xt::xarray<int> a = { 1, 2, 3, 4, 5, 6, 7, 8};
     // The following two lines ...
@@ -124,7 +124,7 @@ values in the ``shape``:
 
 .. code::
 
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
     xt::xarray<int> a = { 1, 2, 3, 4, 5, 6, 7, 8};
     a.reshape({2, -1});
     // a.shape() return {2, 4}
@@ -151,8 +151,8 @@ automatically and applies the "temporary variable rule" by default. A mechanism
 
 .. code::
 
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xnoalias.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xnoalias.hpp>
 
     // a, b, and c are xt::xarrays previously initialized
     xt::noalias(b) = a + c;
@@ -167,7 +167,7 @@ The aliasing phenomenon is illustrated in the following example:
 .. code::
 
     #include <vector>
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
 
     std::vector<size_t> a_shape = {3, 2, 4};
     xt::xarray<double> a(a_shape);

docs/source/developer/concepts.rst

@@ -26,7 +26,7 @@ class whose template parameter is ``A`` and should forward this parameter to ``x
 
 .. code::
 
-    #include "xtensor/xexpression.hpp"
+    #include <xtensor/xexpression.hpp>
 
     template <class T>
     class B : public xexpression<T>
@@ -111,7 +111,7 @@ given shape:
     #include <algorithm>
     #include <iterator>
     #include <iostream>
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
 
     int main(int argc, char* argv[])
     {
@@ -146,8 +146,8 @@ The first overload is meant for computed assignment involving a scalar; it allow
 
 .. code::
 
-    #include "xtensor/xarray.hpp"
-    #include "xio.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xio.hpp>
 
     int main(int argc, char* argv)
     {

docs/source/expression.rst

@@ -126,7 +126,7 @@ You can access the elements of any ``xexpression`` with ``operator()``:
 
 .. code::
 
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
 
     xt::xarray<double> a = {{1., 2., 3.}, {4., 5., 6.}};
     auto f = 2 * a;
@@ -143,7 +143,7 @@ of the expression:
 
 .. code::
 
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
 
     xt::xarray<double> a = {{1., 2., 3.}, {4., 5., 6.}};
 
@@ -167,7 +167,7 @@ Shape
 .. code::
 
     #include <vector>
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xarray.hpp>
 
     using array_type = xt::xarray<double>;
     using shape_type = array_type::shape_type;

docs/source/external-structures.rst

@@ -179,7 +179,7 @@ strides based on the shape and the layout, so the implementation of the ``resize
 
 .. code::
 
-    #include "xtensor/xstrides.hpp" // for utility functions
+    #include <xtensor/xstrides.hpp> // for utility functions
 
     template <class T>
     void resize(const shape_type& shape)

docs/source/file_loading.rst

@@ -28,8 +28,8 @@ save data in the Comma-separated value format. The reference documentation is :d
     #include <fstream>
     #include <iostream>
 
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xcsv.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xcsv.hpp>
 
     int main()
     {
@@ -59,8 +59,8 @@ Reference documentation for the functions used is found here :doc:`api/xnpy`.
     #include <iostream>
     #include <fstream>
 
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xnpy.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xnpy.hpp>
 
     int main()
     {
@@ -85,8 +85,8 @@ The reference documentation is found :doc:`api/xjson`.
 
 .. code::
 
-    #include "xtensor/xjson.hpp"
-    #include "xtensor/xarray.hpp"
+    #include <xtensor/xjson.hpp>
+    #include <xtensor/xarray.hpp>
 
     int main()
     {

docs/source/getting_started.rst

@@ -16,9 +16,9 @@ First example
 .. code::
 
     #include <iostream>
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xio.hpp"
-    #include "xtensor/xview.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xio.hpp>
+    #include <xtensor/xview.hpp>
 
     int main(int argc, char* argv[])
     {
@@ -142,8 +142,8 @@ This second example initializes a 1-dimensional array and reshapes it in-place:
 .. code::
 
     #include <iostream>
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xio.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xio.hpp>
 
     int main(int argc, char* argv[])
     {
@@ -177,16 +177,16 @@ When compiled and run, this produces the following output:
 
   .. code-block:: cpp
 
-      std::cout << xt::adapt(arr.shape()); // with: #include "xtensor/xadapt.hpp"
+      std::cout << xt::adapt(arr.shape()); // with: #include <xtensor/xadapt.hpp>
 
 Third example: index access
 ---------------------------
 
 .. code::
 
     #include <iostream>
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xio.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xio.hpp>
 
     int main(int argc, char* argv[])
     {
@@ -219,9 +219,9 @@ This last example shows how to broadcast the ``xt::pow`` universal function:
 .. code::
 
     #include <iostream>
-    #include "xtensor/xarray.hpp"
-    #include "xtensor/xmath.hpp"
-    #include "xtensor/xio.hpp"
+    #include <xtensor/xarray.hpp>
+    #include <xtensor/xmath.hpp>
+    #include <xtensor/xio.hpp>
 
     int main(int argc, char* argv[])
     {