diff --git a/README.md b/README.md index 820e4f5..ce1ee24 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,17 @@ [![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). +The MkDocs site is built from the files in the [`docs/`](docs/) directory. + +## 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 +``` diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..51e2b23 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,7 @@ +# OpenBrand Documentation + +This site contains documentation about the OpenBrand organization. + +For repository details, see the [main README](../README.md). + +Learn more about our organization on the [profile page](profile.md). diff --git a/docs/profile.md b/docs/profile.md new file mode 100644 index 0000000..0722531 --- /dev/null +++ b/docs/profile.md @@ -0,0 +1,3 @@ +# OpenBrand Profile + +This page mirrors the information in [profile/README.md](../profile/README.md). diff --git a/dummy.py b/dummy.py deleted file mode 100644 index ad81f48..0000000 --- a/dummy.py +++ /dev/null @@ -1,3 +0,0 @@ -def add(a, b): - """Return the sum of a and b.""" - return a + b diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..6de3a16 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,5 @@ +site_name: OpenBrand Docs +nav: + - Home: index.md + - Profile: profile.md +docs_dir: docs diff --git a/profile/README.md b/profile/README.md index ec72684..2c5d7e4 100644 --- a/profile/README.md +++ b/profile/README.md @@ -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! diff --git a/requirements.txt b/requirements.txt index 9955dec..a8f1632 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ pytest pytest-cov +mkdocs diff --git a/tests/test_dummy.py b/tests/test_dummy.py deleted file mode 100644 index 386b5c3..0000000 --- a/tests/test_dummy.py +++ /dev/null @@ -1,4 +0,0 @@ -from dummy import add - -def test_add(): - assert add(1, 2) == 3 diff --git a/tests/test_mkdocs.py b/tests/test_mkdocs.py new file mode 100644 index 0000000..eff575a --- /dev/null +++ b/tests/test_mkdocs.py @@ -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()