Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,16 @@
[![codecov](https://codecov.io/gh/GapIntelligence/.github/branch/main/graph/badge.svg)](https://codecov.io/gh/GapIntelligence/.github)

This repository contains configuration files and documentation used by OpenBrand.

## Documentation

For an overview of the organization, visit the [profile README](profile/README.md).

## Development

This repository uses [MkDocs](https://www.mkdocs.org/) for documentation.
Run the test suite (which also builds the site) with:

```bash
python -m pytest -q
```
3 changes: 0 additions & 3 deletions dummy.py

This file was deleted.

5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
site_name: OpenBrand Docs
nav:
- Home: README.md
- Profile: profile/README.md
docs_dir: .
2 changes: 2 additions & 0 deletions profile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,6 @@ To get started with development, please ensure you have access to the necessary

---

For repository configuration details, see the [main README](../README.md).

Thank you for contributing to OpenBrand's continued success!
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
pytest
pytest-cov
mkdocs
4 changes: 0 additions & 4 deletions tests/test_dummy.py

This file was deleted.

15 changes: 15 additions & 0 deletions tests/test_mkdocs.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import subprocess
from pathlib import Path


def test_mkdocs_build(tmp_path: Path) -> None:
"""Ensure the mkdocs site builds successfully."""
site_dir = tmp_path / "site"
result = subprocess.run([
"mkdocs",
"build",
"--site-dir",
str(site_dir),
], capture_output=True, text=True)
assert result.returncode == 0, result.stderr
assert site_dir.exists()
Loading