dsgovbr-sphinx-theme 0.1.0__tar.gz

dsgovbr_sphinx_theme-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Abrasileirado
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dsgovbr_sphinx_theme-0.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: dsgovbr-sphinx-theme
+Version: 0.1.0
+Summary: Tema Sphinx comunitário e não oficial inspirado no Design System GOV.BR (DSGovBR)
+Author-email: Kelson da Costa Medeiros <kelsoncm@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://abrasileirado.github.io/dsgovbr-sphinx-theme/
+Project-URL: Repository, https://github.com/abrasileirado/dsgovbr-sphinx-theme
+Project-URL: Issues, https://github.com/abrasileirado/dsgovbr-sphinx-theme/issues
+Keywords: sphinx,theme,dsgovbr,gov.br,design-system
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Theme
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: Portuguese (Brazilian)
+Classifier: Operating System :: OS Independent
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+License-File: src/dsgovbr_sphinx_theme/static/fonts/rawline/OFL.txt
+Requires-Dist: sphinx>=7.3
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: doc8>=1.1; extra == "dev"
+Dynamic: license-file
+
+# dsgovbr-sphinx-theme
+
+> Projeto comunitário, independente e **não oficial**. Não representa nem implica
+> homologação ou endosso pelo GOV.BR DS ou pelo Governo Federal.
+
+Tema [Sphinx](https://www.sphinx-doc.org/) com visual inspirado no Padrão Digital de
+Governo ([GOV.BR DS](https://www.gov.br/ds/)): fonte Rawline, tokens de cor do GOV.BR DS,
+cabeçalho, menu lateral, breadcrumb, avisos (*message*), tabelas e rodapé no estilo dos
+componentes do design system, modo escuro e layout responsivo.
+
+Inclui a extensão opcional `dsgovbr_sphinx_theme.componentes`, com diretivas e roles reST
+(`.. br-alerta::`, `.. br-card::`, `.. br-acordeao::`, `:br-badge:`...) para usar nos seus
+`.rst` os componentes do [dsgovbr-bootstraped](https://github.com/abrasileirado/dsgovbr-bootstraped).
+
+Documentação: <https://abrasileirado.github.io/dsgovbr-sphinx-theme/>
+
+## Uso rápido
+
+```bash
+pip install dsgovbr-sphinx-theme
+```
+
+```python
+# docs/conf.py
+html_theme = "dsgovbr_sphinx_theme"
+extensions = [
+    "sphinx.ext.githubpages",
+    "dsgovbr_sphinx_theme.componentes",  # opcional: diretivas br-*
+]
+html_theme_options = {
+    "github_url": "https://github.com/org/repo",
+    "navigation_links": "PyPI|https://pypi.org/project/x/",
+}
+```
+
+```rst
+.. br-alerta:: warning
+   :titulo: Atenção
+
+   Revise os dados antes de continuar.
+
+.. br-abas::
+
+   .. br-aba:: pip
+
+      ``pip install pacote``
+
+   .. br-aba:: uv
+
+      ``uv add pacote``
+```
+
+Opções do tema e a lista completa de componentes estão na documentação.
+
+## Desenvolvimento
+
+```bash
+uv venv && uv pip install -e ".[dev]"
+uv run pytest
+uv run ruff check .
+uv run sphinx-build -W -b html docs docs/_build/html
+```
+
+## Licença
+
+MIT. Fontes e assets de terceiros: ver [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

dsgovbr_sphinx_theme-0.1.0/README.md

@@ -0,0 +1,66 @@
+# dsgovbr-sphinx-theme
+
+> Projeto comunitário, independente e **não oficial**. Não representa nem implica
+> homologação ou endosso pelo GOV.BR DS ou pelo Governo Federal.
+
+Tema [Sphinx](https://www.sphinx-doc.org/) com visual inspirado no Padrão Digital de
+Governo ([GOV.BR DS](https://www.gov.br/ds/)): fonte Rawline, tokens de cor do GOV.BR DS,
+cabeçalho, menu lateral, breadcrumb, avisos (*message*), tabelas e rodapé no estilo dos
+componentes do design system, modo escuro e layout responsivo.
+
+Inclui a extensão opcional `dsgovbr_sphinx_theme.componentes`, com diretivas e roles reST
+(`.. br-alerta::`, `.. br-card::`, `.. br-acordeao::`, `:br-badge:`...) para usar nos seus
+`.rst` os componentes do [dsgovbr-bootstraped](https://github.com/abrasileirado/dsgovbr-bootstraped).
+
+Documentação: <https://abrasileirado.github.io/dsgovbr-sphinx-theme/>
+
+## Uso rápido
+
+```bash
+pip install dsgovbr-sphinx-theme
+```
+
+```python
+# docs/conf.py
+html_theme = "dsgovbr_sphinx_theme"
+extensions = [
+    "sphinx.ext.githubpages",
+    "dsgovbr_sphinx_theme.componentes",  # opcional: diretivas br-*
+]
+html_theme_options = {
+    "github_url": "https://github.com/org/repo",
+    "navigation_links": "PyPI|https://pypi.org/project/x/",
+}
+```
+
+```rst
+.. br-alerta:: warning
+   :titulo: Atenção
+
+   Revise os dados antes de continuar.
+
+.. br-abas::
+
+   .. br-aba:: pip
+
+      ``pip install pacote``
+
+   .. br-aba:: uv
+
+      ``uv add pacote``
+```
+
+Opções do tema e a lista completa de componentes estão na documentação.
+
+## Desenvolvimento
+
+```bash
+uv venv && uv pip install -e ".[dev]"
+uv run pytest
+uv run ruff check .
+uv run sphinx-build -W -b html docs docs/_build/html
+```
+
+## Licença
+
+MIT. Fontes e assets de terceiros: ver [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

dsgovbr_sphinx_theme-0.1.0/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,36 @@
+# Avisos de terceiros
+
+Este pacote redistribui, sem modificação, os arquivos abaixo.
+
+## Fonte Rawline
+
+- Arquivos: `src/dsgovbr_sphinx_theme/static/fonts/rawline/*.woff2` (pesos 300 a 700).
+- Origem: CDN do GOV.BR DS (SERPRO),
+  `https://cdngovbr-ds.estaleiro.serpro.gov.br/design-system/fonts/rawline/`,
+  mesma cópia usada no site do dsgovbr-bootstraped.
+- Licença: **SIL Open Font License 1.1** (`OFL.txt` ao lado das fontes;
+  copyright "The Raleway Project Authors"; a Rawline deriva da Raleway).
+- Motivo da cópia: o CDN não envia `Access-Control-Allow-Origin`, o que impede
+  carregar a fonte com SRI.
+
+## dsgovbr-bootstraped
+
+- Arquivo: `src/dsgovbr_sphinx_theme/componentes_static/vendor/dsgovbr-bootstraped/dsgovbr-bootstraped.min.css`
+- Versão: dsgovbr-bootstraped **v0.11.0** (inclui Bootstrap 5.3.8 compilado).
+- Origem: <https://github.com/abrasileirado/dsgovbr-bootstraped>
+- Licença: MIT (`LICENSE` ao lado do arquivo).
+
+## Bootstrap
+
+- Arquivo: `src/dsgovbr_sphinx_theme/componentes_static/vendor/bootstrap/bootstrap.bundle.min.js`
+  (inclui Popper).
+- Versão: Bootstrap **v5.3.8**.
+- Origem: <https://github.com/twbs/bootstrap>
+- Licença: MIT (`LICENSE` ao lado do arquivo).
+
+Os dois últimos só são carregados quando a extensão
+`dsgovbr_sphinx_theme.componentes` está ativa. Para atualizá-los, veja
+`scripts/atualizar_vendor.py`.
+
+Este projeto é comunitário, independente e não oficial; não representa nem implica
+endosso pelo GOV.BR DS, pelo Governo Federal ou pelo projeto Bootstrap.

dsgovbr_sphinx_theme-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dsgovbr-sphinx-theme"
+version = "0.1.0"
+description = "Tema Sphinx comunitário e não oficial inspirado no Design System GOV.BR (DSGovBR)"
+readme = "README.md"
+authors = [{ name = "Kelson da Costa Medeiros", email = "kelsoncm@gmail.com" }]
+license = "MIT"
+license-files = ["LICENSE", "THIRD_PARTY_NOTICES.md", "src/dsgovbr_sphinx_theme/static/fonts/rawline/OFL.txt"]
+requires-python = ">=3.10"
+dependencies = ["sphinx>=7.3"]
+keywords = ["sphinx", "theme", "dsgovbr", "gov.br", "design-system"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: Sphinx",
+    "Framework :: Sphinx :: Theme",
+    "Intended Audience :: Developers",
+    "Natural Language :: Portuguese (Brazilian)",
+    "Operating System :: OS Independent",
+    "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",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "ruff>=0.6", "doc8>=1.1"]
+
+[project.urls]
+Homepage = "https://abrasileirado.github.io/dsgovbr-sphinx-theme/"
+Repository = "https://github.com/abrasileirado/dsgovbr-sphinx-theme"
+Issues = "https://github.com/abrasileirado/dsgovbr-sphinx-theme/issues"
+
+[project.entry-points."sphinx.html_themes"]
+dsgovbr_sphinx_theme = "dsgovbr_sphinx_theme"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+dsgovbr_sphinx_theme = [
+    "*.html",
+    "theme.toml",
+    "static/css/*.css",
+    "static/js/*.js",
+    "static/fonts/rawline/*",
+    "componentes_static/vendor/*/*",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B"]

dsgovbr_sphinx_theme-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

dsgovbr_sphinx_theme-0.1.0/src/dsgovbr_sphinx_theme/__init__.py

@@ -0,0 +1,71 @@
+"""Tema Sphinx comunitário e não oficial inspirado no Design System GOV.BR (DSGovBR)."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+from pathlib import Path
+from typing import Any
+
+try:
+    __version__ = version("dsgovbr-sphinx-theme")
+except PackageNotFoundError:  # pragma: no cover - execução a partir do código-fonte
+    __version__ = "0.0.0"
+
+THEME_NAME = "dsgovbr_sphinx_theme"
+
+
+def get_html_theme_path() -> str:
+    """Retorna o diretório do tema (o que contém ``theme.toml``).
+
+    Mantido para quem ainda usa ``html_theme_path``; com o pacote instalado o
+    Sphinx encontra o tema pelo *entry point* ``sphinx.html_themes``.
+    """
+    return str(Path(__file__).resolve().parent)
+
+
+def _parse_links(raw: Any) -> list[tuple[str, str]]:
+    """Converte ``navigation_links`` em pares (título, destino).
+
+    Aceita lista de pares/dicionários ou a string ``"Título|destino, Outro|url"``.
+    """
+    if not raw:
+        return []
+    links: list[tuple[str, str]] = []
+    if isinstance(raw, str):
+        for item in raw.split(","):
+            if not item.strip():
+                continue
+            title, _, target = item.partition("|")
+            if not target.strip():
+                raise ValueError(
+                    f"[{THEME_NAME}] navigation_links: item {item.strip()!r} sem destino; "
+                    "use 'Título|destino'."
+                )
+            links.append((title.strip(), target.strip()))
+        return links
+    for item in raw:
+        if isinstance(item, dict):
+            links.append((str(item["title"]), str(item["url"])))
+        else:
+            title, target = item
+            links.append((str(title), str(target)))
+    return links
+
+
+def _html_page_context(
+    app: Any, pagename: str, templatename: str, context: dict[str, Any], doctree: Any
+) -> None:
+    """Expõe ``dsgovbr_navigation_links`` já normalizado para os templates."""
+    options = context.get("theme_navigation_links")
+    context["dsgovbr_navigation_links"] = _parse_links(options)
+
+
+def setup(app: Any) -> dict[str, Any]:
+    """Registra o tema no Sphinx."""
+    app.add_html_theme(THEME_NAME, get_html_theme_path())
+    app.connect("html-page-context", _html_page_context)
+    return {
+        "version": __version__,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }