2.15.0 - Improved extras.git + documentation/comments overhaul

 - `privex.helpers.extras.git`
    - Added PyDoc comment block for module
    - Renamed `AsyncGit` to `_AsyncGit` and removed the `awaitable_class` decorator.
      The decorator causes problems with IDEs being able to provide code insight when using it,
      and also prevents Sphinx being able to document it.

      To resolve this, while keeping `awaitable_class` functionality, `AsyncGit` is now a variable
      which wraps the bare class `_AsyncGit` using `AsyncGit = awaitable_class(_AsyncGit)`, allowing
      Sphinx and IDEs to be able to access the bare undecorated class when needed to provide insight,
      while retaining `awaitable_class` for both async and non-async compatibility.

    - Renamed `_AsyncGit._git` to `_AsyncGit.git` so that projects can cleanly access the lower level direct `git` CLI call
      if they need to.

    - Made several improvements to `_AsyncGit.commit`

    - Added `_AsyncGit.__getattr__` magic method, which allows unimplemented sub-command calls such as `.count_objects()`
      to be automagically translated into `.git('count-objects')`

    - Added/improved PyDoc blocks for most methods

 - Added some missing requirements to `requirements.txt`

 - Bumped dependency versions in `extras/docs.txt`

 - Changed the relative module imports in `privex.helpers.cache.asyncx.__init__` to be absolute imports, as the
   relative imports were causing problems with Sphinx being able to read the module.

 - Comments have been cleaned up to comply with Sphinx properly, along with adding and improving PyDoc across
   several modules in privex-helpers - too many changes to list (and they don't affect functionality so...)

**Documentation**

 - Overhauled the documentation to be compatible with modern Sphinx
    - Changes to the docs config file
        - Stopped autodoc/autosummary overwriting existing RST files without warning
        - Attempted to silence some of the annoying warnings which I can't fix without breaking references, though
          silencing hasn't been very effective.
    - Adjusted the Makefile to use `-b` instead of `-M`, and added a `clean` segment, since `make clean` no longer
      works via sphinx-build

 - Re-generated and hand corrected a lot of API documentation, since many parts of the API docs were no longer rendering correctly
   due to changes in Sphinx.

 - Replaced bare module path titles like `privex.helpers.cache`, with more friendly and descriptive titles such as
   `Framework-independent Cache System` and `Common/General Helpers`.

 - Re-organised the documentation for many existing modules

 - Added documentation for the `thread` and `geoip` modules

 - Re-added the documentation for `types` and `settings` (they were previously obliterated by autodoc)

 - Many other improvements to the docs (a good 100+ docs files have been created/deleted/updated)

Author: Someguy123

docs/Makefile

@@ -22,7 +22,12 @@ live:
 rst:
 	sphinx-apidoc -o "$(SOURCEDIR)/helpers/" ../ ../setup.py ../dist ../build ../privex_helpers.egg-info '**__pycache__**'
 
+
+clean:
+	rm -r $(BUILDDIR)
+
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -j 8 -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -j 8 -b $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/_templates/autosummary/class.rst

@@ -3,6 +3,7 @@
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
+   :members:
 
 {% block methods %}
    .. automethod:: __init__

docs/source/_templates/autosummary/module.rst

@@ -8,7 +8,7 @@
    .. rubric:: Attributes
 
    .. autosummary::
-      :toctree: {{ name | lower }}
+      :toctree: {{ name }}
    {% for item in attributes %}
       ~{{ name }}.{{ item }}
    {%- endfor %}

docs/source/conf.py

@@ -53,9 +53,17 @@
 ]
 
 autosummary_generate = True
+autosummary_generate_overwrite = False
 
 autodoc_default_flags = ['members']
 
+
+# Silence stupid "duplicate description" and similar warnings. Adding :noindex: like it demands just causes reference links to break...
+suppress_warnings = [
+    'app.add_node',  # Silence stupid "duplicate description" and similar warnings. Adding :noindex: causes reference links to break...
+    'ref.python'     # Silence "more than one target found for cross-reference" warnings
+]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']