How to Test

Test Locally

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

You can test mkdocs-tacc clients the same way; some 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:
```
python -m venv venv
source venv/bin/activate
pip install -e ".[all]"
mkdocs serve
```
A mkdocs-tacc client may require install of additional or different dependencies. See its documentation.

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:
```
poetry install --sync --extras "all"
poetry run mkdocs serve
```
A mkdocs-tacc client may require install of additional or different dependencies. See its documentation.

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:
```
docker compose up
```
A mkdocs-tacc client may rely on a different command. See its documentation.

To deactivate environment: docker compose stop

To remove environment: docker compose down

* Make

Ensure Make is available:
```
make --version
```
To install dependencies and serve docs in isolation:
```
make start
```
A mkdocs-tacc client may rely on a different command. See its documentation.

To deactivate environment: Ctrl+C

To remove environment: make stop

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

To test changes end-to-end on client repository:

Install the theme at a specific 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 changes real-time on client repository: