sphinx-gp-theme 0.0.1a8__tar.gz

sphinx_gp_theme-0.0.1a8/.gitignore

@@ -0,0 +1,228 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Generated by sphinx_fonts extension (downloaded at build time)
+docs/_static/fonts/
+docs/_static/css/fonts.css
+
+# Claude Code
+**/CLAUDE.local.md
+**/CLAUDE.*.md
+**/.claude/settings.local.json
+
+# Playwright MCP
+.playwright-mcp/
+
+# Repo-local pytest mirror (do not track — validator-only)
+out/
+
+# Misc
+.vim/
+*.lprof
+pip-wheel-metadata/
+monkeytype.sqlite3

sphinx_gp_theme-0.0.1a8/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: sphinx-gp-theme
+Version: 0.0.1a8
+Summary: Furo child theme for git-pull project documentation
+Project-URL: Repository, https://github.com/git-pull/gp-sphinx
+Author-email: Tony Narlock <tony@git-pull.com>
+License: MIT
+Keywords: documentation,furo,sphinx,theme
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Theme
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.10
+Requires-Dist: furo
+Requires-Dist: sphinx>=8.1
+Description-Content-Type: text/markdown
+
+# sphinx-gp-theme
+
+Furo child theme for [git-pull](https://github.com/git-pull) project documentation.
+
+Inherits from [Furo](https://pradyunsg.me/furo/) and bundles shared templates,
+custom CSS (heading refinements, TOC, typography, view transitions), SPA navigation
+JS, and the git-pull project sidebar.
+
+## Install
+
+```console
+$ pip install sphinx-gp-theme
+```
+
+## Usage
+
+In your `docs/conf.py`:
+
+```python
+html_theme = "sphinx-gp-theme"
+```
+
+Or use with [gp-sphinx](https://gp-sphinx.git-pull.com) which sets the theme automatically.

sphinx_gp_theme-0.0.1a8/README.md

@@ -0,0 +1,23 @@
+# sphinx-gp-theme
+
+Furo child theme for [git-pull](https://github.com/git-pull) project documentation.
+
+Inherits from [Furo](https://pradyunsg.me/furo/) and bundles shared templates,
+custom CSS (heading refinements, TOC, typography, view transitions), SPA navigation
+JS, and the git-pull project sidebar.
+
+## Install
+
+```console
+$ pip install sphinx-gp-theme
+```
+
+## Usage
+
+In your `docs/conf.py`:
+
+```python
+html_theme = "sphinx-gp-theme"
+```
+
+Or use with [gp-sphinx](https://gp-sphinx.git-pull.com) which sets the theme automatically.

sphinx_gp_theme-0.0.1a8/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "sphinx-gp-theme"
+version = "0.0.1a8"
+description = "Furo child theme for git-pull project documentation"
+requires-python = ">=3.10,<4.0"
+authors = [
+  {name = "Tony Narlock", email = "tony@git-pull.com"}
+]
+license = { text = "MIT" }
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "License :: OSI Approved :: MIT License",
+  "Framework :: Sphinx",
+  "Framework :: Sphinx :: Theme",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Documentation",
+  "Topic :: Documentation :: Sphinx",
+  "Typing :: Typed",
+]
+readme = "README.md"
+keywords = ["sphinx", "theme", "furo", "documentation"]
+dependencies = [
+  "sphinx>=8.1",
+  "furo",
+]
+
+[project.entry-points."sphinx.html_themes"]
+"sphinx-gp-theme" = "sphinx_gp_theme"
+
+[project.urls]
+Repository = "https://github.com/git-pull/gp-sphinx"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sphinx_gp_theme"]

sphinx_gp_theme-0.0.1a8/src/sphinx_gp_theme/__init__.py

@@ -0,0 +1,82 @@
+"""sphinx-gp-theme — Furo child theme for git-pull projects.
+
+Provides a shared visual identity for git-pull project documentation
+by inheriting from Furo and bundling common templates, CSS, and JS.
+
+Examples
+--------
+>>> import pathlib
+
+>>> theme_path = get_theme_path()
+>>> theme_path.is_dir()
+True
+
+>>> (theme_path / "theme.conf").is_file()
+True
+"""
+
+from __future__ import annotations
+
+import pathlib
+import typing as t
+
+if t.TYPE_CHECKING:
+    from sphinx.application import Sphinx
+
+__version__ = "0.0.1a8"
+
+
+def get_theme_path() -> pathlib.Path:
+    """Return the path to the sphinx-gp-theme theme directory.
+
+    Returns
+    -------
+    pathlib.Path
+        Absolute path to the theme directory containing
+        ``theme.conf`` and associated templates/static files.
+
+    Examples
+    --------
+    >>> theme_path = get_theme_path()
+    >>> (theme_path / "theme.conf").exists()
+    True
+
+    >>> (theme_path / "static" / "css" / "custom.css").exists()
+    True
+    """
+    return pathlib.Path(__file__).parent / "theme"
+
+
+def setup(app: Sphinx) -> dict[str, bool | str]:
+    """Register the bundled theme with Sphinx.
+
+    Parameters
+    ----------
+    app : Sphinx
+        The Sphinx application object.
+
+    Returns
+    -------
+    dict[str, bool | str]
+        Extension metadata for Sphinx.
+
+    Examples
+    --------
+    >>> class FakeApp:
+    ...     def __init__(self) -> None:
+    ...         self.calls: list[tuple[str, pathlib.Path]] = []
+    ...     def add_html_theme(self, name: str, theme_path: pathlib.Path) -> None:
+    ...         self.calls.append((name, theme_path))
+    >>> fake = FakeApp()
+    >>> metadata = setup(fake)  # type: ignore[arg-type]
+    >>> fake.calls[0][0]
+    'sphinx-gp-theme'
+    >>> metadata["parallel_read_safe"]
+    True
+    """
+    app.add_html_theme("sphinx-gp-theme", get_theme_path())
+    return {
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+        "version": __version__,
+    }

sphinx_gp_theme-0.0.1a8/src/sphinx_gp_theme/theme/page.html

@@ -0,0 +1,78 @@
+{% extends "furo/page.html" %}
+{%- block extrahead %}
+  {{ super() }}
+  {%- for href in font_preload_hrefs|default([]) %}
+  <link rel="preload" href="{{ pathto('_static/fonts/' + href, 1) }}" as="font" type="font/woff2" crossorigin="">
+  {%- endfor %}
+  {%- if font_faces is defined and font_faces %}
+  <style id="sphinx-fonts">
+  {%- for face in font_faces %}
+  @font-face {
+    font-family: "{{ face.family }}";
+    font-style: {{ face.style }};
+    font-weight: {{ face.weight }};
+    font-display: block;
+    src: url("{{ pathto('_static/fonts/' + face.filename, 1) }}") format("woff2");
+  }
+  {%- endfor %}
+  {%- for fb in font_fallbacks|default([]) %}
+  @font-face {
+    font-family: "{{ fb.family }}";
+    src: {{ fb.src }};
+    size-adjust: {{ fb.size_adjust }};
+    ascent-override: {{ fb.ascent_override }};
+    descent-override: {{ fb.descent_override }};
+    line-gap-override: {{ fb.line_gap_override }};
+  }
+  {%- endfor %}
+  body {
+  {%- for var, value in font_css_variables.items() %}
+    {{ var }}: {{ value }};
+  {%- endfor %}
+  }
+  </style>
+  {%- endif %}
+  {%- if theme_show_meta_manifest_tag == true %}
+  <link rel="manifest" href="/manifest.json">
+  {% endif -%}
+  {%- if theme_show_meta_og_tags == true %}
+  <meta name="description" content="{{ theme_project_description }}">
+
+  <!-- Open Graph / Facebook -->
+  <meta property="og:type" content="website">
+  <meta property="og:url" content="{{ theme_project_url }}/">
+  <meta property="og:title" content="{{ theme_project_title }}">
+  <meta property="og:description" content="{{ theme_project_description }}">
+  <meta property="og:image" itemprop="image" content="{{ theme_project_url }}/_static/img/icons/icon-192x192.png">
+
+  <!-- Twitter -->
+  <meta property="twitter:card" content="summary_large_image">
+  <meta property="twitter:url" content="{{ theme_project_url }} ">
+  <meta property="twitter:title" content="{{ theme_project_title }}">
+  <meta property="twitter:description" content="{{ theme_project_description }}">
+  <meta property="twitter:image" content="{{ theme_project_url }}/_static/img/icons/icon-512x512.png">
+  {% endif -%}
+  {%- if theme_show_meta_app_icon_tags == true %}
+  <meta name="theme-color" content="#ffffff">
+  <meta name="application-name" content="{{ theme_project_name }}">
+
+  <link rel="shortcut icon" href="/_static/favicon.ico">
+  <link rel="icon" type="image/png" sizes="512x512" href="/_static/img/icons/icon-512x512.png">
+  <link rel="icon" type="image/png" sizes="192x192" href="/_static/img/icons/icon-192x192.png">
+  <link rel="icon" type="image/png" sizes="32x32" href="/_static/img/icons/icon-32x32.png">
+  <link rel="icon" type="image/png" sizes="96x96" href="/_static/img/icons/icon-96x96.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="/_static/img/icons/icon-16x16.png">
+
+  <!-- Apple -->
+  <meta name="apple-mobile-web-app-title" content="{{ theme_project_name }}">
+
+  <link rel="apple-touch-icon" sizes="192x192" href="/_static/img/icons/icon-192x192.png">
+
+  <!-- Microsoft -->
+  <meta name="msapplication-TileColor" content="#ffffff">
+  <meta name="msapplication-TileImage" content="/_static/img/icons/ms-icon-144x144.png">
+  {% endif -%}
+  {%- if theme_mask_icon %}
+  <link rel="mask-icon" href="{{ theme_mask_icon }}" color="grey">
+  {%- endif %}
+{% endblock %}

sphinx_gp_theme-0.0.1a8/src/sphinx_gp_theme/theme/sidebar/brand.html

@@ -0,0 +1,18 @@
+<a class="sidebar-brand{% if logo %} centered{% endif %}" href="{{ pathto(master_doc) }}">
+  {%- block brand_content %}
+  {%- if logo_url %}
+  <div class="sidebar-logo-container">
+    <img class="sidebar-logo" src="{{ logo_url }}" width="200" height="200" decoding="async" alt="Logo"/>
+  </div>
+  {%- endif %}
+  {%- if theme_light_logo and theme_dark_logo %}
+  <div class="sidebar-logo-container">
+    <img class="sidebar-logo only-light" src="{{ pathto('_static/' + theme_light_logo, 1) }}" width="200" height="200" decoding="async" alt="Light Logo"/>
+    <img class="sidebar-logo only-dark" src="{{ pathto('_static/' + theme_dark_logo, 1) }}" width="200" height="200" decoding="async" alt="Dark Logo"/>
+  </div>
+  {%- endif %}
+  {% if not theme_sidebar_hide_name %}
+  <span class="sidebar-brand-text">{{ docstitle if docstitle else project }}</span>
+  {%- endif %}
+  {% endblock brand_content %}
+</a>

sphinx_gp_theme-0.0.1a8/src/sphinx_gp_theme/theme/sidebar/projects.html

@@ -0,0 +1,84 @@
+<div class="sidebar-tree projects" id="sidebar-projects">
+  <p class="caption" role="heading">
+    <span class="caption-text"
+      >team git-pull / <a href="https://tony.sh">Tony Narlock</a></span
+    >:
+  </p>
+
+  <p class="indented-block">
+    <span class="project-name">vcs-python</span>
+    <a class="internal" href="https://vcspull.git-pull.com">vcspull</a>
+    (<a class="internal" href="https://libvcs.git-pull.com">libvcs</a>),
+    <a class="internal" href="https://g.git-pull.com">g</a>
+  </p>
+  <p class="indented-block">
+    <span class="project-name">tmux-python</span>
+    <span class="indent">
+      <a class="internal" href="https://tmuxp.git-pull.com">tmuxp</a>
+    </span>
+    <span class="indent">
+      <a class="internal" href="https://libtmux.git-pull.com">libtmux</a>
+      (<a class="internal" href="https://libtmux-mcp.git-pull.com">mcp</a>,
+      <a class="internal" href="https://libtmux.git-pull.com/pytest-plugin/">pytest</a>)
+    </span>
+  </p>
+
+  <p class="indented-block">
+    <span class="project-name">cihai</span>
+    <span class="indent">
+      <a class="internal" href="https://unihan-etl.git-pull.com">unihan-etl</a>
+      (<a class="internal" href="https://unihan-db.git-pull.com">db</a>)
+    </span>
+    <span class="indent">
+      <a class="internal" href="https://cihai.git-pull.com">cihai</a>
+      (<a class="internal" href="https://cihai-cli.git-pull.com">cli</a>)
+    </span>
+  </p>
+
+  <p class="indented-block">
+    <span class="project-name">django</span>
+    <span class="indent">
+      <a class="internal" href="https://django-slugify-processor.git-pull.com">django-slugify-processor</a>
+    </span>
+    <span class="indent">
+      <a class="internal" href="https://django-docutils.git-pull.com">django-docutils</a>
+    </span>
+  </p>
+
+  <p class="indented-block">
+    <span class="project-name">docs + tests</span>
+    <span class="indent">
+      <a class="internal" href="https://gp-libs.git-pull.com">gp-libs</a>
+    </span>
+  </p>
+
+  <p class="indented-block">
+    <span class="project-name">web</span>
+    <span class="indent">
+      <a class="internal" href="https://social-embed.org">social-embed</a>
+    </span>
+  </p>
+</div>
+<script type="text/javascript">
+(() => {
+  const sidebar = document.getElementById("sidebar-projects");
+  const loc = window.location;
+  sidebar.querySelectorAll("a[href]").forEach((link) => {
+    const url = new URL(link.href, loc.origin);
+    const sameHost = url.hostname === loc.hostname;
+    const hasPath = url.pathname.replace(/\/+$/, "").length > 0;
+    // Links with a pathname: match origin + path prefix (e.g. /pytest-plugin/)
+    // Links without: match hostname only (e.g. https://libtmux.git-pull.com)
+    const isActive = hasPath
+      ? sameHost && loc.pathname.startsWith(url.pathname.replace(/\/+$/, ""))
+      : sameHost;
+    if (isActive && !link.classList.contains("active")) {
+      const d = document.createElement('span');
+      d.textContent = link.textContent;
+      d.classList.add("active");
+      link.parentNode.replaceChild(d, link);
+    }
+  });
+  sidebar.classList.add('ready');
+})()
+</script>