pythonic-fp-circulararray 6.0.2__tar.gz → 6.0.3__tar.gz

pythonic_fp_circulararray-6.0.3/.github/workflows/static.yml

@@ -0,0 +1,59 @@
+name: Build and Deploy Furo Themed Sphinx Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Select Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install Sphinx Dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Build Release Docs
+        run: |
+          pip install pythonic-fp-circulararray
+          cp docs/index_release.rst docs/source/index.rst
+          cp docs/conf_release.py docs/source/conf.py
+          sphinx-build -M html docs/source docs/build/release
+
+      - name: Build Development Docs
+        run: |
+          pip install -e .
+          cp docs/index_devel.rst docs/source/index.rst
+          cp docs/conf_devel.py docs/source/conf.py
+          sphinx-build -M html docs/source docs/build/development
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v6
+
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: docs/build
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v5
+        id: deployment

{pythonic_fp_circulararray-6.0.2 → pythonic_fp_circulararray-6.0.3}/.gitignore

@@ -1,6 +1,10 @@
 # Minimal version - only add to when necessary
 **/__pycache__/
 dist/
+docs/build/release/
+docs/build/development/
+docs/source/conf.py
+docs/source/index.rst
 **/.dmypy.json
 **/.mypy_cache/
 **/.pytest_cache/

{pythonic_fp_circulararray-6.0.2 → pythonic_fp_circulararray-6.0.3}/CHANGELOG.rst

@@ -17,6 +17,19 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+PyPI 6.0.3 - 2026-04-25
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The pythonic-fp-circulararray GitHub repo now will be automatically
+building the current release documentation and the latest development
+documentation on GitHub for display on the project's GitHub Pages.
+
+PyPI 6.0.2 - 2026-04-21
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Milestone for pythonic-fp-circulararray. Sphinx docs more or less in
+their final form for the project.
+
 PyPI 6.0.1 - 2026-01-08
 ~~~~~~~~~~~~~~~~~~~~~~~
 

{pythonic_fp_circulararray-6.0.2 → pythonic_fp_circulararray-6.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 6.0.2
+Version: 6.0.3
 Summary: Circular Array
 Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -62,11 +62,11 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/circulararray>`_.
+<https://grscheller.github.io/pythonic-fp-circulararray>`_.
 
 Copyright and License
 ---------------------
 
-Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.
 

{pythonic_fp_circulararray-6.0.2 → pythonic_fp_circulararray-6.0.3}/README.rst

@@ -38,10 +38,10 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/circulararray>`_.
+<https://grscheller.github.io/pythonic-fp-circulararray>`_.
 
 Copyright and License
 ---------------------
 
-Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.

pythonic_fp_circulararray-6.0.3/docs/Makefile

@@ -0,0 +1,47 @@
+# Makefile for Sphinx documentation
+#
+# Important Note: "make devel" and "make release" will just
+# use the first pythonic_fp.circulararray package found.
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+STATICDIR     = source/_static
+TEMPLATEDIR   = source/_templates
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+Makefile:
+	mkdir -p $(STATICDIR) $(TEMPLATEDIR)
+
+# Build development labeled html docs.
+devel: Makefile
+	rm -rf "$(BUILDDIR)"/development
+	rm -f "$(SOURCEDIR)"/index.rst "$(SOURCEDIR)"/conf.py
+	cp index_devel.rst "$(SOURCEDIR)"/index.rst
+	cp conf_devel.py "$(SOURCEDIR)"/conf.py
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/development $(SPHINXOPTS)
+
+# Build release labeled html docs.
+release: Makefile
+	rm -rf "$(BUILDDIR)"/release
+	rm -f "$(SOURCEDIR)"/index.rst "$(SOURCEDIR)"/conf.py
+	cp index_release.rst "$(SOURCEDIR)"/index.rst
+	cp conf_release.py "$(SOURCEDIR)"/conf.py
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/release $(SPHINXOPTS)
+
+.PHONY: help Makefile devel release
+
+# Catch-all target: route all unknown targets to Sphinx, build development docs
+%: Makefile
+	rm -rf "$(BUILDDIR)"/development
+	rm -f "$(SOURCEDIR)"/index.rst "$(SOURCEDIR)"/conf.py
+	cp index_devel.rst "$(SOURCEDIR)"/index.rst
+	cp conf_devel.py "$(SOURCEDIR)"/conf.py
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)"/development $(SPHINXOPTS)

pythonic_fp_circulararray-6.0.3/docs/build/index.html

@@ -0,0 +1,44 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8" />
+  <title>PyPI Project: pythonic-fp-circulararray</title>
+  <link rel="stylesheet" href="style.css" />
+</head>
+
+<body>
+  <table>
+    <tr>
+      <td>
+        <h3>Pythonic FP Circular Array</h3>
+        <dl>
+          <dt>Circular Array - pythonic-fp-circulararray:</dt>
+          <dd><a href="https://pypi.org/project/pythonic-fp-circulararray/"> PyPI</a></dd>
+          <dd><a href="https://github.com/grscheller/pythonic-fp-circulararray"> GitHub</a></dd>
+        </dl>
+
+        <dl>
+          <dt>Circular Array Documentation:</dt>
+          <dd><a href="https://grscheller.github.io/pythonic-fp-circulararray/release/html/"> Latest release</a></dd>
+          <dd><a href="https://grscheller.github.io/pythonic-fp-circulararray/development/html/"> Development</a></dd>
+        </dl>
+      </td>
+
+      <td>
+        <h3>Related PyPI Projects</h3>
+        <dl>
+          <dt>Pythonic Functional Programming:</dt>
+          <dd><a href="https://grscheller.github.io/pythonic-fp/"> Pythonic FP Homepage</a></dd>
+        </dl>
+
+        <dl>
+          <dt>Daddy's Boring Math Library :</dt>
+          <dd><a href="https://grscheller.github.io/boring-math/"> Boring Math Homepage</a></dd>
+        </dl>
+      </td>
+    </tr>
+  </table>
+</body>
+
+</html>

pythonic_fp_circulararray-6.0.3/docs/build/style.css

@@ -0,0 +1,44 @@
+body {
+    color: #c5c9c5;
+    background-color: #181616;
+    font-family: cantarell,liberation,arial,helvetica,sans-serif
+}
+
+a:link {
+    color: #6884c0;
+    text-decoration: none;
+}
+
+a:visited {
+    color: #7e9cd8;
+    text-decoration: none;
+}
+
+a:hover {
+    text-decoration: underline;
+}
+
+h3 {
+    color: #b6927b;
+    margin-left: 20px;
+}
+
+table {
+    width: 100%;
+}
+
+td {
+    vertical-align: top;
+}
+
+dt {
+    color: #acafac;
+    margin-left: 20px;
+    margin-top: 5px;
+}
+
+dd {
+    color: #c5c9c5;
+    margin-left: 20px;
+    padding-left: 15px;
+}

pythonic_fp_circulararray-6.0.3/docs/conf_devel.py

@@ -0,0 +1,68 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# https://www.sphinx-doc.org/en/master/usage/index.html
+#
+# Must match what is in pyproject.toml, also delete "Proposed"
+# in the release string in source/index.rst when generating
+# the docs for an actual, not proposed, release.
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = 'Pythonic FP - Circular Array'
+copyright = '2023-2026, Geoffrey R. Scheller'
+author = 'Geoffrey R. Scheller'
+release = '6.0.3'
+
+
+def skip_abc_methods(
+    app: Any, what: str, name: str, obj: Any, skip: bool, options: Any
+) -> bool:
+    if name in [
+        '__init_subclass__',
+        '__subclasshook__',
+        '__class_getitem__',
+        '__weakref__',
+    ]:
+        return True  # Skip these members
+    return skip
+
+
+def setup(app: Sphinx) -> None:
+    app.connect('autodoc-skip-member', skip_abc_methods)
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.graphviz',
+]
+
+autodoc_default_options = {
+    'members': True,
+    'private-members': True,
+    'special-members': True,
+    'inherited-members': True,
+    'show-inheritance': True,
+}
+autodoc_member_order = 'bysource'
+autoclass_content = 'both'
+autodoc_class_signature = 'separated'
+autodoc_typehints_format = 'short'
+autodoc_use_type_comments = True
+autodoc_docstring_signature = False
+autodoc_preserve_defaults = True
+autodoc_warningiserror = False
+
+templates_path = ['_templates']
+exclude_patterns: list[str] = []
+
+html_theme_options = {
+    'light_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+    'dark_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+}
+html_theme = 'furo'
+html_static_path = ['_static']

pythonic_fp_circulararray-6.0.3/docs/conf_release.py

@@ -0,0 +1,68 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# https://www.sphinx-doc.org/en/master/usage/index.html
+#
+# Must match what is in pyproject.toml, also delete "Proposed"
+# in the release string in source/index.rst when generating
+# the docs for an actual, not proposed, release.
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = 'Pythonic FP - Circular Array'
+copyright = '2023-2026, Geoffrey R. Scheller'
+author = 'Geoffrey R. Scheller'
+release = '6.0.2'
+
+
+def skip_abc_methods(
+    app: Any, what: str, name: str, obj: Any, skip: bool, options: Any
+) -> bool:
+    if name in [
+        '__init_subclass__',
+        '__subclasshook__',
+        '__class_getitem__',
+        '__weakref__',
+    ]:
+        return True  # Skip these members
+    return skip
+
+
+def setup(app: Sphinx) -> None:
+    app.connect('autodoc-skip-member', skip_abc_methods)
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.graphviz',
+]
+
+autodoc_default_options = {
+    'members': True,
+    'private-members': True,
+    'special-members': True,
+    'inherited-members': True,
+    'show-inheritance': True,
+}
+autodoc_member_order = 'bysource'
+autoclass_content = 'both'
+autodoc_class_signature = 'separated'
+autodoc_typehints_format = 'short'
+autodoc_use_type_comments = True
+autodoc_docstring_signature = False
+autodoc_preserve_defaults = True
+autodoc_warningiserror = False
+
+templates_path = ['_templates']
+exclude_patterns: list[str] = []
+
+html_theme_options = {
+    'light_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+    'dark_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+}
+html_theme = 'furo'
+html_static_path = ['_static']

pythonic_fp_circulararray-6.0.3/docs/index_devel.rst

@@ -0,0 +1,30 @@
+pythonic-fp-circulararray
+=========================
+
+Project
+`pythonic-fp-circulararray <https://pypi.org/project/pythonic-fp-circulararray/>`_
+one of the
+`Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
+PyPI projects.
+
+**Proposed PyPI 6.0.3 release**
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    docs/index

pythonic_fp_circulararray-6.0.3/docs/index_release.rst

@@ -0,0 +1,30 @@
+pythonic-fp-circulararray
+=========================
+
+Project
+`pythonic-fp-circulararray <https://pypi.org/project/pythonic-fp-circulararray/>`_
+one of the
+`Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
+PyPI projects.
+
+**PyPI 6.0.2 release**
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    docs/index

pythonic_fp_circulararray-6.0.3/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx>=9.1
+furo

pythonic_fp_circulararray-6.0.3/docs/source/changelog.rst

@@ -0,0 +1,7 @@
+changelog
+=========
+
+Change log for the
+`pythonic-fp-circulararray
+<https://github.com/grscheller/pythonic-fp-circulararray/blob/main/CHANGELOG.rst>`_
+PyPI project.

pythonic_fp_circulararray-6.0.3/docs/source/description.rst

@@ -0,0 +1,7 @@
+Description
+-----------
+
+.. automodule:: pythonic_fp.circulararray
+    :synopsis:
+    :noindex:
+

pythonic_fp_circulararray-6.0.3/docs/source/docs/auto.rst

@@ -0,0 +1,4 @@
+auto resizing 
+-------------
+
+.. automodule:: pythonic_fp.circulararray.auto

pythonic_fp_circulararray-6.0.3/docs/source/docs/fixed.rst

@@ -0,0 +1,4 @@
+fixed capacity
+--------------
+
+.. automodule:: pythonic_fp.circulararray.fixed

pythonic_fp_circulararray-6.0.3/docs/source/docs/index.rst

@@ -0,0 +1,17 @@
+Circular Arrays
+---------------
+
+.. automodule:: pythonic_fp.circulararray
+    :synopsis:
+
+.. toctree::
+    :caption: Auto resizing circular array
+    :maxdepth: 1
+
+    auto
+
+.. toctree::
+    :caption: Fixed capacity circular array
+    :maxdepth: 1
+
+    fixed

pythonic_fp_circulararray-6.0.3/docs/source/releases.rst

@@ -0,0 +1,36 @@
+PyPI releases
+=============
+
+**pythonic-fp-circulararray:** pythonic_fp.circulararray
+
++-------------------------------------------------------------------------------------------+--------------+
+| PyPI Release                                                                              | Release date |
++===========================================================================================+==============+
+| `development <https://grscheller.github.io/pythonic-fp-circulararray/development/html/>`_ |              |
++-------------------------------------------------------------------------------------------+--------------+
+| `v6.0.2 <https://grscheller.github.io/pythonic-fp-circulararray/release/html/>`_          | 2026-04-21   |
++-------------------------------------------------------------------------------------------+--------------+
+| v6.0.1                                                                                    | 2026-01-08   |
++-------------------------------------------------------------------------------------------+--------------+
+| v6.0.0                                                                                    | 2025-09-26   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.4.0                                                                                    | 2025-09-25   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.3.3                                                                                    | 2025-09-21   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.3.2                                                                                    | 2025-09-04   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.3.1                                                                                    | 2025-08-02   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.3.0                                                                                    | 2025-08-02   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.2.0                                                                                    | 2025-07-13   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.1.2                                                                                    | 2025-07-06   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.1.1                                                                                    | 2025-07-06   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.1.0                                                                                    | 2025-07-04   |
++-------------------------------------------------------------------------------------------+--------------+
+| v5.0.0                                                                                    | 2025-05-23   |
++-------------------------------------------------------------------------------------------+--------------+

pythonic_fp_circulararray-6.0.3/docs/source/usage.rst

@@ -0,0 +1,32 @@
+usage
+=====
+
+How to installing the package
+-----------------------------
+
+Install the project into your Python environment:
+
+.. code:: console
+
+   $ pip install pythonic-fp.circulararray
+
+Importing the package
+---------------------
+
+Import the circulararray classes and "factory functions" into your code.
+
+.. code:: python
+
+    from pythonic_fp.circulararray.auto import CA, ca
+    from pythonic_fp.circulararray.fixed import CAF, caf
+
+.. note::
+
+    The behaviors of the ``CA`` and ``CAF`` classes were modeled after the Python ``list`` builtin.
+
+    - they can be instantiated with data by supplying an iterable
+    - with no unnamed arguments they are instantiated empty
+    - methods which modify the objects return no values
+    - their corresponding factory functions ``ca`` and ``caf`` behave like Python's ``[]`` syntax.
+
+      - each creates its corresponding circulararray object from the arguments passed to it

{pythonic_fp_circulararray-6.0.2 → pythonic_fp_circulararray-6.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "pythonic-fp-circulararray"
-version = "6.0.2"
+version = "6.0.3"
 readme = "README.rst"
 requires-python = ">=3.13"
 authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]