pythonic-fp-circulararray 6.0.4__tar.gz → 6.1.0__tar.gz

{pythonic_fp_circulararray-6.0.4 → pythonic_fp_circulararray-6.1.0}/.github/workflows/static.yml

@@ -5,6 +5,11 @@ on:
     branches: ["main"]
   workflow_dispatch:
 
+env:
+  RELEASE: '6.1.0'
+  DEVEL: '6.1.1'
+  PYTHON: '3.14'
+
 permissions:
   contents: read
   pages: write
@@ -27,23 +32,23 @@ jobs:
       - name: Select Python
         uses: actions/setup-python@v6
         with:
-          python-version: '3.14'
+          python-version: ${{ env.PYTHON }}
 
       - name: Install Sphinx Dependencies
-        run: pip install -r docs/requirements.txt
+        run: |
+          pip install -r docs/requirements.txt
+          sudo apt-get install -y graphviz
 
       - 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
+          docs/gen_conf.py release ${{ env.RELEASE }} CircularArray circulararray > 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
+          docs/gen_conf.py devel ${{ env.DEVEL }} CircularArray circulararray > docs/source/conf.py
           sphinx-build -M html docs/source docs/build/development
 
       - name: Setup Pages

{pythonic_fp_circulararray-6.0.4 → pythonic_fp_circulararray-6.1.0}/.gitignore

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

{pythonic_fp_circulararray-6.0.4 → pythonic_fp_circulararray-6.1.0}/CHANGELOG.rst

@@ -17,6 +17,15 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+PyPI 6.1.0 - 2026-05-03
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Migrated to the new document build system I developed for the
+queue project.
+
+Had to bump minor version number due to a small difference on what
+CAF.__str__ and CA.__str__ now display.
+
 PyPI 6.0.3 - 2026-04-25
 ~~~~~~~~~~~~~~~~~~~~~~~
 

{pythonic_fp_circulararray-6.0.4 → pythonic_fp_circulararray-6.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 6.0.4
+Version: 6.1.0
 Summary: Circular Array
 Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -17,8 +17,8 @@ License-File: LICENSE
 Requires-Dist: pythonic-fp-gadgets>=4.0.2
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-circulararray/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-circulararray/
-Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/html/
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/projects/circulararray.html
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-circulararray
 Provides-Extra: test
 
@@ -54,15 +54,15 @@ Python module implementing stateful circular array data structures.
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp>`_
+<https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
 Documentation
 -------------
 
-Documentation for this project is hosted on
+Documentation and other links for this project are hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp-circulararray>`_.
+<https://grscheller.github.io/pythonic-fp/projects/circulararray.html>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_circulararray-6.0.4 → pythonic_fp_circulararray-6.1.0}/README.rst

@@ -30,15 +30,15 @@ Python module implementing stateful circular array data structures.
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp>`_
+<https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
 Documentation
 -------------
 
-Documentation for this project is hosted on
+Documentation and other links for this project are hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp-circulararray>`_.
+<https://grscheller.github.io/pythonic-fp/projects/circulararray.html>`_.
 
 Copyright and License
 ---------------------

pythonic_fp_circulararray-6.1.0/docs/Makefile

@@ -0,0 +1,78 @@
+# Makefile for Sphinx documentation
+
+# Last and future releases
+#  - former needs to agree with PyPI
+#  - later needs to agree with pyproject.toml
+PROJECT_NAME = CircularArray
+PYPI_NAME = circularArray
+RELEASE_VERSION = 6.1.0
+DEVEL_VERSION = 6.1.1
+CUSTOM_VERSION = 0.0.0
+
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = source
+BUILDDIR = build
+
+STATICDIR = source/_static
+TEMPLATEDIR = source/_templates
+
+# Put help first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+clean_source:
+	@rm -f "$(SOURCEDIR)"/conf.py
+
+clean_devel:
+	@rm -rf "$(BUILDDIR)"/development
+
+clean_release:
+	@rm -rf "$(BUILDDIR)"/release
+
+clean_custom:
+	@rm -rf "$(BUILDDIR)"/custom
+
+clean: clean_devel clean_release clean_custom clean_source
+	@rm -rf $(BUILDDIR)
+	@echo Removed all doc build artifacts.
+
+setup_devel: clean_devel
+	@./gen_conf.py devel "$(DEVEL_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
+
+setup_release: clean_release
+	@./gen_conf.py release "$(RELEASE_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
+
+setup_custom: clean_custom
+	@./gen_conf.py custom "$(CUSTOM_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
+
+setup_redo: clean_custom
+	@echo Redoing custom build with a possibly reeditted conf.py
+	@./gen_conf.py redo "" "" ""
+
+# Build development labeled html docs.
+devel: Makefile setup_devel
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/development $(SPHINXOPTS)
+
+# Build release labeled html docs.
+release: Makefile setup_release
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/release $(SPHINXOPTS)
+
+# Build custom labeled html docs.
+custom: Makefile setup_custom
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
+
+# Build HTML docs with previous generated (possibly hand edited) source/conf.py,
+# put results in $(BUILDDIR)/custom.
+redo: Makefile setup_redo
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
+
+# Catch-all target: route all unknown targets to Sphinx and save to $(BUILDDIR)/custom.
+# Reuse a previously generated source/conf.py.
+%: Makefile setup_redo
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
+
+.PHONY: help Makefile
+.PHONY: setup_devel setup_release setup_custom
+.PHONY: devel release
+.PHONY: clean_source clean_devel clean_release clean_custom clean

pythonic_fp_circulararray-6.1.0/docs/gen_conf.py

@@ -0,0 +1,109 @@
+#!/usr/bin/env python
+# Generate conf.py Sphinx configuration executable
+
+import sys
+import os
+
+project_prefix = 'Pythonic FP'
+pypi_prefix = 'pythonic-fp'
+author = 'Geoffrey R. Scheller'
+copyright = f'2023-2026, {author}'
+
+args = sys.argv[1:]
+num_args = len(args)
+
+if num_args == 4:
+    build_type, version, project_name, pypi_name = args
+    project = project_prefix + ' - ' + project_name
+    pypi_project_repo = pypi_prefix + '-' + pypi_name
+    project_url_rst = f'`{project} <https://pypi.org/project/{pypi_project_repo}/>`_'
+    homepage_url_rst = f'`{project_prefix} <https://grscheller.github.io/{pypi_prefix}/>`_'
+
+else:
+    sys.exit('Error: gen_conf.py takes exactly 4 arguments')
+
+match build_type:
+    case 'custom':
+        release = f'{version}'
+        release_string = f'**Custom PyPI Non-release version {release}**'
+    case 'devel':
+        release = f'{version}'
+        release_string = f'**Proposed PyPI release version {release}**'
+    case 'release':
+        release = f'{version}'
+        release_string = f'**PyPI release version {release}**'
+    case 'redo':
+        if not os.path.isfile('source/conf.py'):
+            sys.exit('Error: cannot redo without source/conf.py')
+        sys.exit()
+    case _:
+        sys.exit(f'Error: unknown built_type {build_type} given')
+
+print(f'''# Generated conf.py Sphinx configuration executable
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = '{project}'
+author = '{author}'
+copyright = '{copyright}'
+release = '{release}'
+release_string = '{release_string}'
+
+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': False,
+    'show-inheritance': True,
+}}
+autodoc_member_order = 'bysource'
+autoclass_content = 'class'
+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']
+
+rst_epilog = """
+.. |RELEASE_STRING| replace:: {release_string}
+
+"""
+''')

{pythonic_fp_circulararray-6.0.4 → pythonic_fp_circulararray-6.1.0}/pyproject.toml

@@ -4,10 +4,12 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "pythonic-fp-circulararray"
-version = "6.0.4"
+version = "6.1.0"
 readme = "README.rst"
 requires-python = ">=3.13"
-authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
+authors = [
+  { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
+]
 keywords = [
   "auto resizing",
   "circular array",
@@ -33,8 +35,8 @@ dynamic = ["description"]
 
 [project.urls]
 Changelog = "https://github.com/grscheller/pythonic-fp-circulararray/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp-circulararray/"
-Homepage = "https://grscheller.github.io/pythonic-fp/homepage/html/"
+Documentation = "https://grscheller.github.io/pythonic-fp/projects/circulararray.html"
+Homepage = "https://grscheller.github.io/pythonic-fp/"
 Source = "https://github.com/grscheller/pythonic-fp-circulararray"
 
 [project.optional-dependencies]

{pythonic_fp_circulararray-6.0.4 → pythonic_fp_circulararray-6.1.0}/src/pythonic_fp/circulararray/__init__.py

@@ -14,19 +14,17 @@
 
 """
 Circular Array
---------------
+==============
 
-.. admonition:: Stateful circular array data structures.
+.. admonition:: Stateful circular array data structures
 
-    - O(1) pops and pushes either end
+    - O(1) pops and pushes on either side
     - O(1) size determination
     - O(1) indexing
-    - Two types of circular arrays, fixed and variable capacity
+    - two types of circular arrays
 
-.. note::
-
-    - Class constructors ``CA`` and ``CAF`` take an optional iterator to populate circular array.
-    - Factory Functions ``ca`` and ``caf`` take a variable number of parameters to populate circular array.
+      - fixed capacity: ``CAF``
+      - variable capacity: ``CA``
 
 """