[merge] Read the doc support & convert md to rst #88

.readthedocs.yml

@@ -0,0 +1,9 @@
+version: 2
+
+sphinx:
+  configuration: documentation/source/conf.py
+formats: all
+python:
+  version: 3.8
+  install:
+    - requirements: documentation/requirements.txt

CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.rst

@@ -1,6 +1,8 @@
-# Contributor Covenant Code of Conduct
+Contributor Covenant Code of Conduct
+====================================
 
-## Our Pledge
+Our Pledge
+----------
 
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
@@ -9,29 +11,31 @@ size, disability, ethnicity, sex characteristics, gender identity and expression
 level of experience, education, socio-economic status, nationality, personal
 appearance, race, religion, or sexual identity and orientation.
 
-## Our Standards
+Our Standards
+--------------
 
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
  professional setting
 
-## Our Responsibilities
+Our Responsibilities
+--------------------
 
 Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
@@ -43,7 +47,8 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-## Scope
+Scope
+-----
 
 This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community. Examples of
@@ -52,10 +57,11 @@ address, posting via an official social media account, or acting as an appointed
 representative at an online or offline event. Representation of a project may be
 further defined and clarified by project maintainers.
 
-## Enforcement
+Enforcement
+-----------
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at info@inexor.org. All
+reported by contacting the project team at ``info@inexor.org``. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -65,12 +71,11 @@ Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
 
-## Attribution
+Attribution
+-----------
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`__, version 1.4,
 available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: https://www.contributor-covenant.org
-
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq

CONTRIBUTING.rst

@@ -0,0 +1,29 @@
+We are always open for suggestions or pull requests.
+
+Join our discord server: https://discord.gg/acUW8k7.
+
+`Iceflower <https://github.com/IceflowRE>`__
+    - Threadpool improvements.
+    - Advice on thread safety and code design.
+    - CMake improvements and feedback.
+    - Feedback on Travis CI and Github actions.
+    - Support for `Exhale <https://exhale.readthedocs.io/en/latest/>`__.
+
+`Shikijo <https://github.com/Shikijo>`__
+    - Pointed out broken glsl compiler batch script on Windows.
+
+`Croydon <https://github.com/Croydon>`__
+    - Advice on `conan package manager <https://conan.io/>`__.
+
+`uilianries <https://github.com/uilianries>`__
+    - `Travis CI setup <https://stackoverflow.com/questions/61209668/travis-ci-reports-linker-errors-for-gcc-7-for-a-vulkan-project>`__
+
+`yeetari <https://github.com/yeetari>`__
+    - Building and testing vulkan-renderer on Linux.
+    - Added USE_VMA_RECORDING CMake option so vulkan-renderer can be build on Linux until VMA recording has been ported.
+    - Feedback on Travis CI and Github actions.
+    - Add build instructions for gentoo.
+    - Replace ``_DEBUG`` with NDEBUG.
+
+`joetoth <https://github.com/joetoth>`__
+    - Help with Discord server.