Doc improvements

[waywardmonkeys]

This leaves a class of warnings from Sphinx ... I'm not sure which copy of the docs should be removed:

cglm/docs/source/affine-pre.rst:81: WARNING: Duplicate C declaration, also defined at affine-common:28.
Declaration is '.. c:function:: void  glm_translate_make(mat4 m, vec3 v)'.
cglm/docs/source/affine-pre.rst:89: WARNING: Duplicate C declaration, also defined at affine-common:36.
Declaration is '.. c:function:: void  glm_scale_to(mat4 m, vec3 v, mat4 dest)'.
cglm/docs/source/affine-pre.rst:98: WARNING: Duplicate C declaration, also defined at affine-common:45.
Declaration is '.. c:function:: void  glm_scale_make(mat4 m, vec3 v)'.
cglm/docs/source/affine-pre.rst:106: WARNING: Duplicate C declaration, also defined at affine-common:53.
Declaration is '.. c:function:: void  glm_scale(mat4 m, vec3 v)'.
cglm/docs/source/affine-pre.rst:115: WARNING: Duplicate C declaration, also defined at affine-common:62.
Declaration is '.. c:function:: void  glm_scale_uni(mat4 m, float s)'.
cglm/docs/source/affine-pre.rst:154: WARNING: Duplicate C declaration, also defined at affine-common:71.
Declaration is '.. c:function:: void  glm_rotate_make(mat4 m, float angle, vec3 axis)'.
cglm/docs/source/affine-pre.rst:183: WARNING: Duplicate C declaration, also defined at affine-common:81.
Declaration is '.. c:function:: void  glm_rotate_atm(mat4 m, vec3 pivot, float angle, vec3 axis)'.
cglm/docs/source/affine-pre.rst:196: WARNING: Duplicate C declaration, also defined at affine-common:94.
Declaration is '.. c:function:: void  glm_decompose_scalev(mat4 m, vec3 s)'.
cglm/docs/source/affine-pre.rst:204: WARNING: Duplicate C declaration, also defined at affine-common:102.
Declaration is '.. c:function:: bool  glm_uniscaled(mat4 m)'.
cglm/docs/source/affine-pre.rst:212: WARNING: Duplicate C declaration, also defined at affine-common:110.
Declaration is '.. c:function:: void  glm_decompose_rs(mat4 m, mat4 r, vec3 s)'.
cglm/docs/source/affine-pre.rst:222: WARNING: Duplicate C declaration, also defined at affine-common:120.
Declaration is '.. c:function:: void  glm_decompose(mat4 m, vec4 t, mat4 r, vec3 s)'.

[waywardmonkeys]

Not sure why Codacy / Appveyor / Travis are still showing up in the CI here. :(

[recp]

@waywardmonkeys I also removed these from Settings / Integrations / Applications there was lot of integrations 🤷‍♂️

This leaves a class of warnings from Sphinx ... I'm not sure which copy of the docs should be removed

We were moved some affine transforms into separate files pre multiplied, post multiplied and common. For instance glm_decompose() is in common which can be validated in cglm/*.h headers. I was unaware of these warnings, thanks for the fix 🤗

---

EDIT:

I have just removed these from in settings/branch_protection_rules ( Require status checks to pass before merging ). I hope it will work now.

[waywardmonkeys]

Updated to fix those warnings and some other stuff. Also made the CI job fail when there are new warnings in the docs.

[recp]

@waywardmonkeys many thanks, the PR is merged 🚀

[waywardmonkeys]

You're welcome. There's a lot that could be done to the docs, but I have to balance commitments of time and energy!

[recp]

There's a lot that could be done to the docs, but I have to balance commitments of time and energy!

No time constraints for docs :) I'll also try do do my best in free time for docs and tests. Thanks anyway 🤗