Metadata-Version: 2.4
Name: dsgovbr-sphinx-theme
Version: 0.1.2
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).
