diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..fa156a8 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,29 @@ +name: Publish docs via GitHub Pages + +on: + push: + branches: + - main + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: Install dependencies + run: | + pip install --upgrade pip + pip install -e ".[dev]" + - name: Configure Git user + run: | + git config --local user.email "github-actions[bot]@users.noreply.github.com" + git config --local user.name "github-actions[bot]" + - name: Deploy to GitHub Pages + run: mkdocs gh-deploy --force diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml index 812ea24..824d071 100644 --- a/.github/workflows/python-package.yml +++ b/.github/workflows/python-package.yml @@ -18,14 +18,13 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v3 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip pip install -e ".[dev]" - pip install pytest - name: Test with pytest run: | pytest diff --git a/README.md b/README.md index f616499..318486a 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ The `did` library provides a framework for managing and querying data that is or To run the test suite, use the following command: ```bash -python -m unittest discover tests +pytest ``` This will discover and run all the tests in the `tests` directory. diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..6d2ce7a --- /dev/null +++ b/docs/api.md @@ -0,0 +1,3 @@ +# API Reference + +Coming soon. diff --git a/mkdocs.yml b/mkdocs.yml index e49e3f2..f353149 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,6 @@ site_name: DID-Python +theme: + name: material nav: - Home: index.md - API Reference: api.md diff --git a/pyproject.toml b/pyproject.toml index a419742..86d7714 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,6 +24,7 @@ dev = [ "mkdocs", "mkdocs-material", "mkdocstrings[python]", + "pytest", ] [tool.setuptools]