DOC: improvements to developers documentation (#732)

* DOC: improvements to developers documentation

* MNT: git rename a few files from the root directory

* DOC: more upgrades to development docs

* DEV: create script to delete local branches that no longer exist on remote

* DOC: I followed the step by step, looked at other parts of the documentation, and didn't find anything to correct or improve. I think it's fine as it is. I added a model to requirements.txt, which was missing when I ran the make html command.

* DOC: Update developer docs on sphinx building.

* DOC: Clarify testing structure on testing docs.

* DOC: Re-run docs requirements freeze.

* DOC: Introduce Conflicts Guideline and update First PR.

* DOC: fixing typos on development docs.

* DOC: Solve review comments of dev docs.

* DOC: final touches to developers documentation

* DOC: update cSpell configuration to enable additional file types

* DEV: move docker ignore file

---------

Co-authored-by: Julio Machado <[email protected]>
Co-authored-by: Pedro Bressan <[email protected]>
Co-authored-by: Lucas de Oliveira Prates <[email protected]>

Author: 4 people

CITATION.cff renamed to .github/CITATION.cff

@@ -0,0 +1,2 @@
+# Delete local branches that no longer exists on remote (windows command line)
+git branch -vv | Where-Object { $_ -match 'gone\]' } | ForEach-Object { $_.Trim().Split()[0] } | ForEach-Object { git branch -D $_ }

CODEOWNERS renamed to .github/CODEOWNERS

@@ -5,12 +5,14 @@
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
     "autoDocstring.docstringFormat": "numpy",
-    "cSpell.enableFiletypes": [
-        "python",
-        "jupyter",
-        "markdown",
-        "restructuredtext"
-    ],
+    "cSpell.enabledFileTypes": {
+        "plaintext": true,
+        "python": true,
+        "jupyter": true,
+        "markdown": true,
+        "tex": true,
+        "rst": true
+    },
     "cSpell.language": "en-US",
     "cSpell.words": [
         "Abdulklech",

CODE_OF_CONDUCT.md renamed to .github/CODE_OF_CONDUCT.md

@@ -40,6 +40,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx.ext.mathjax",
+    "sphinx_tabs.tabs",
     "sphinx_copybutton",
     "sphinx_design",
     "jupyter_sphinx",