Added docs for last commit, plus lots of cleanup of page titles

Author: Someguy123

docs/Makefile

@@ -20,7 +20,7 @@ live:
 
 # Generate API docs in source/code, making sure to exclude setup.py, dist, build, and egg info etc.
 rst:
-	sphinx-apidoc -o "$(SOURCEDIR)/code/" ../ ../setup.py ../dist ../build ../privex_helpers.egg-info '**__pycache__**'
+	sphinx-apidoc -o "$(SOURCEDIR)/helpers/" ../ ../setup.py ../dist ../build ../privex_helpers.egg-info '**__pycache__**'
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

docs/source/_templates/autosummary/base.rst

@@ -0,0 +1,5 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}

docs/source/_templates/autosummary/class.rst

@@ -0,0 +1,29 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: Methods
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Attributes
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,36 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: Functions
+
+   .. autosummary::
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: Classes
+
+   .. autosummary::
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: Exceptions
+
+   .. autosummary::
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/source/helpers/asyncx/privex.helpers.asyncx.async_sync.rst

@@ -1,5 +1,5 @@
-privex.helpers.asyncx.async\_sync
-=================================
+async\_sync
+===========
 
 .. currentmodule:: privex.helpers.asyncx
 

docs/source/helpers/asyncx/privex.helpers.asyncx.run_sync.rst

@@ -1,5 +1,5 @@
-privex.helpers.asyncx.run\_sync
-===============================
+run\_sync
+=========
 
 .. currentmodule:: privex.helpers.asyncx
 

docs/source/helpers/cache/cacheadapter/privex.helpers.cache.CacheAdapter.CacheAdapter.__init__.rst

@@ -0,0 +1,6 @@
+\_\_init\_\_
+============
+
+.. currentmodule:: privex.helpers.cache.CacheAdapter
+
+.. automethod:: CacheAdapter.__init__

docs/source/helpers/cache/cacheadapter/privex.helpers.cache.CacheAdapter.CacheAdapter.get.rst

@@ -0,0 +1,6 @@
+get
+===
+
+.. currentmodule:: privex.helpers.cache.CacheAdapter
+
+.. automethod:: CacheAdapter.get

docs/source/helpers/cache/cacheadapter/privex.helpers.cache.CacheAdapter.CacheAdapter.get_or_set.rst

@@ -0,0 +1,6 @@
+get\_or\_set
+============
+
+.. currentmodule:: privex.helpers.cache.CacheAdapter
+
+.. automethod:: CacheAdapter.get_or_set

docs/source/helpers/cache/cacheadapter/privex.helpers.cache.CacheAdapter.CacheAdapter.remove.rst

@@ -0,0 +1,6 @@
+remove
+======
+
+.. currentmodule:: privex.helpers.cache.CacheAdapter
+
+.. automethod:: CacheAdapter.remove