Docs and PyPI

Author: isarandi

.github/workflows/python-publish.yml

@@ -0,0 +1,35 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install build dependencies
+        run: python -m pip install --upgrade build
+
+      - name: Build package distribution
+        run: python -m build --sdist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.10"
+  commands:
+    - python -m pip install .
+    - python -m pip install --no-cache-dir -r docs/requirements.txt
+    - python -m sphinx -E -b html docs $READTHEDOCS_OUTPUT/html
+
+sphinx:
+   configuration: docs/conf.py

docs/_static/styles/my_theme.css

@@ -1,11 +1,11 @@
 @import url("theme.css");
 @import url("https://fonts.googleapis.com/css2?family=Mona+Sans:ital,wght@0,200..900;1,200..900&family=Geist:wght@100..900&&family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&family=Outfit:wght@100..900&display=swap");
 
-@media (min-width: 960px) {
+/*@media (min-width: 960px) {
     .bd-page-width {
         max-width: 120rem;
     }
-}
+}*/
 
 #rtd-footer-container {
     margin-top: 0 !important;
@@ -59,6 +59,18 @@ body {
   max-width: 100%;  /* default is 60em */
 }
 
-.bd-sidebar-primary {
-    width: 18%;
-}
+/*.bd-sidebar-primary {
+    max-width: 20%;
+}*/
+
+/* Ensure links in code blocks are underlined */
+.highlight a {
+    text-decoration: underline;
+    color: #394198; /* Adjust color as needed */
+}
+
+/* For additional emphasis, change hover effect */
+.highlight a:hover {
+    text-decoration: underline;
+    color: #9090ff;
+}

docs/_templates/autoapi/index.rst

@@ -1,6 +1,8 @@
 API Reference
 =============
 
+Start at :class:`barecat.Barecat` to explore the API.
+
 .. toctree::
    :titlesonly:
 

docs/_templates/autoapi/python/class.rst

@@ -1,3 +1,5 @@
+:html_theme.sidebar_secondary.remove: true
+
 {% if obj.display %}
    {% if is_own_page %}
 {{ obj.name }}
@@ -100,20 +102,47 @@ Classes
 
 
       {% endif %}
-      {% set visible_methods = own_page_children|selectattr("type", "equalto", "method")|list %}
-      {% if visible_methods %}
-Methods
--------
+
+      {% set static_methods = own_page_children|selectattr("type", "equalto", "method")|selectattr("properties", "defined")|selectattr("properties", "equalto", ["staticmethod"])|list %}
+      {% set class_methods = own_page_children|selectattr("type", "equalto", "method")|selectattr("properties", "defined")|selectattr("properties", "equalto", ["classmethod"])|list %}
+      {% set instance_methods = own_page_children|selectattr("type", "equalto", "method")|rejectattr("properties", "equalto", ["staticmethod"])|rejectattr("properties", "equalto", ["classmethod"])|list %}
+
+      {% if instance_methods %}
+Instance Methods
+----------------
 
 .. autoapisummary::
 
-            {% for method in visible_methods %}
+         {% for method in instance_methods %}
    {{ method.id }}
-            {% endfor %}
+         {% endfor %}
 
 
       {% endif %}
+      {% if class_methods %}
+Class Methods
+-------------
+
+.. autoapisummary::
+
+         {% for method in class_methods %}
+   {{ method.id }}
+         {% endfor %}
 
+
+      {% endif %}
+      {% if static_methods %}
+Static Methods
+--------------
+
+.. autoapisummary::
+
+         {% for method in static_methods %}
+   {{ method.id }}
+         {% endfor %}
+
+
+      {% endif %}
    {% endif %}
 {% endif %}
 

docs/_templates/autoapi/python/data.rst

@@ -1,3 +1,5 @@
+:html_theme.sidebar_secondary.remove: true
+
 {% if obj.display %}
    {% if is_own_page %}
 {{ obj.name }}

docs/_templates/autoapi/python/function.rst

@@ -1,3 +1,5 @@
+:html_theme.sidebar_secondary.remove: true
+
 {% if obj.display %}
    {% if is_own_page %}
 {{ obj.name }}

docs/_templates/autoapi/python/method.rst

@@ -1,3 +1,5 @@
+:html_theme.sidebar_secondary.remove: true
+
 {% if obj.display %}
    {% if is_own_page %}
 {{ obj.name }}

docs/_templates/autoapi/python/module.rst

@@ -1,3 +1,5 @@
+:html_theme.sidebar_secondary.remove: true
+
 {% if obj.display %}
    {% if is_own_page %}
 {{ obj.id }}

docs/_templates/autoapi/python/property.rst

@@ -1,3 +1,5 @@
+:html_theme.sidebar_secondary.remove: true
+
 {% if obj.display %}
    {% if is_own_page %}
 {{ obj.name }}