Merge pull request #118 from nauaneed/master2main

rename master to main in docs

Author: prabhuramachandran

README.rst

@@ -9,7 +9,7 @@ Compyle: execute a subset of Python on HPC platforms
 .. |Documentation Status| image:: https://readthedocs.org/projects/compyle/badge/?version=latest
     :target: https://compyle.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status
-.. |Coverage Status| image:: https://codecov.io/gh/pypr/compyle/branch/master/graph/badge.svg
+.. |Coverage Status| image:: https://codecov.io/gh/pypr/compyle/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/pypr/compyle
 
 Compyle allows users to execute a restricted subset of Python (almost similar
@@ -102,6 +102,6 @@ Examples
 ---------
 
 Some simple examples and benchmarks are available in the `examples
-<https://github.com/pypr/compyle/tree/master/examples>`_ directory.
+<https://github.com/pypr/compyle/tree/main/examples>`_ directory.
 
 You may also run these examples on the `Google Colab notebook`_

docs/source/installation.rst

@@ -32,7 +32,7 @@ repository and install compyle like so::
 If you just want the latest version and do not want to clone the repository,
 you can also do::
 
-  $ pip install https://github.com/pypr/compyle/zipball/master
+  $ pip install https://github.com/pypr/compyle/zipball/main
 
 
 .. _PyOpenCL: https://documen.tician.de/pyopencl/

docs/source/overview.rst

@@ -139,32 +139,32 @@ More examples
 --------------
 
 More complex examples (but still fairly simple) are available in the `examples
-<https://github.com/pypr/compyle/tree/master/examples>`_ directory.
+<https://github.com/pypr/compyle/tree/main/examples>`_ directory.
 
-- `axpb.py <https://github.com/pypr/compyle/tree/master/examples/axpb.py>`_: the
+- `axpb.py <https://github.com/pypr/compyle/tree/main/examples/axpb.py>`_: the
   above example but for openmp and opencl compared with serial showing that in
   some cases serial is actually faster than parallel!
 
 - `vm_elementwise.py
-  <https://github.com/pypr/compyle/tree/master/examples/vm_elementwise.py>`_:
+  <https://github.com/pypr/compyle/tree/main/examples/vm_elementwise.py>`_:
   shows a simple N-body code with two-dimensional point vortices. The code uses
   a simple elementwise operation and works with OpenMP and OpenCL.
 
 - `vm_numba.py
-  <https://github.com/pypr/compyle/tree/master/examples/vm_numba.py>`_: shows
+  <https://github.com/pypr/compyle/tree/main/examples/vm_numba.py>`_: shows
   the same code written in numba for comparison. In our benchmarks, Compyle is
   actually faster even in serial and in parallel it can be much faster when you
   use all cores.
 
 - `vm_kernel.py
-  <https://github.com/pypr/compyle/tree/master/examples/vm_kernel.py>`_: shows
+  <https://github.com/pypr/compyle/tree/main/examples/vm_kernel.py>`_: shows
   how one can write a low-level OpenCL kernel in pure Python and use that. This
   also shows how you can allocate and use local (or shared) memory which is
   often very important for performance on GPGPUs. This code will only run via
   PyOpenCL.
 
 - `bench_vm.py
-  <https://github.com/pypr/compyle/tree/master/examples/bench_vm.py>`_:
+  <https://github.com/pypr/compyle/tree/main/examples/bench_vm.py>`_:
   Benchmarks the various vortex method results above for a comparison with
   numba.