docs(prof.py): overhaul documentation to align with Google Python Style Guide

- Updated project references from Profanity to CProof.
- Removed Python 2 and unicode references.
- Added type hints for all parameters and return types.
- Organized functions into logical sections with RST comments for Sphinx.
- Improved wording for clarity and precision based on source code analysis.
- Ensured compliance with Google Python Style Guide for readable docstrings.

Related to #30

.github/workflows/main.yml

@@ -102,8 +102,8 @@ jobs:
           sudo apt-get install -y --no-install-recommends make doxygen
       - name: Test C API docs generation
         run: |
-          cd profanity/apidocs/c/
-          rm -rf html && doxygen c-prof.conf
+          cd apidocs/c/
+          doxygen c-prof.conf
 
   test-python-api-docs:
     runs-on: ubuntu-latest
@@ -116,5 +116,5 @@ jobs:
           sudo apt-get install -y --no-install-recommends make python3-sphinx
       - name: Test Python API docs generation
         run: |
-          cd profanity/apidocs/python/
+          cd apidocs/python/
           sphinx-apidoc -f -o . src && make -j$(nproc) xml