How to Test

Test Locally

You can test mkdocs-tacc or mkdocs-tacc clients locally with PIP or Poetry.

Some clients also support Docker and Make. *

PIP

PIP should be at least version 21.3.
```
pip --version
```
Only checks current version. Upgrade command is different.
To install dependencies and serve docs in isolation:
Test mkdocs-tacc Repo
To test client instead, use Test Client Repo tab.
```
python -m venv venv
source venv/bin/activate
pip install -e ".[all]"
mkdocs serve
```
Test Client Repo
The client repo might require additional or different commands. Check its documentation.
```
python -m venv venv
source venv/bin/activate
pip install "."
mkdocs serve
```

To deactivate environment: deactivate

To remove environment: rm -rf venv

Poetry

Poetry should be at least version 1.5.0.
```
poetry --version
```
Only checks current version. Upgrade command is different.
To install dependencies and serve docs in isolation:
Test mkdocs-tacc Repo
To test client instead, use Test Client Repo tab.
```
poetry install --sync --extras "all"
poetry run mkdocs serve
```
Test Client Repo
The client repo might require additional or different commands. Check its documentation.
```
poetry install --sync
poetry run mkdocs serve
```

To deactivate environment: exit

To remove environment: poetry env remove --all

* Docker

Docker should be at least version 20.10.0.
```
docker --version
```
Only checks current version. Upgrade command is different.
To install dependencies and serve docs in isolation:

The client repo might require additional or different commands. Check its documentation.
```
docker compose up
```

To deactivate environment: docker compose stop

To remove environment: docker compose down

* Make

To deactivate environment: Ctrl+C

To remove environment: make stop

Some clients will offer automatic, remote build and deploy for testing.

As you follow Test Locally instructions, use Test Client Repo tab.

Test mkdocs-tacc Repo

Ignore this tab. Read the other tab.

Test Client Repo

Read this tab. Ignore the other tab.

To test a specific revision of mkdocs-tacc on a client repository:

Install the theme at a specific revision (e.g. a version) —

PIP

pip install mkdocs-tacc==0.5.0

Poetry

poetry add mkdocs-tacc@0.5.0

— or a specific branch —

PIP

pip install "mkdocs-tacc[all] @ git+https://github.com/TACC/mkdocs-tacc.git#work-in-progress"

Poetry

poetry add "mkdocs-tacc[all] @ git+https://github.com/TACC/mkdocs-tacc.git#work-in-progress"

— or other revision.

To test mkdocs-tacc theme changes in real-time on a client repository: