Pre-release
This release is a pre-release and may not be stable for production use.
MkDocs TACC Theme
A TACC-styled MkDocs theme based on MkDocs' own ReadTheDocs theme.
Create a New MkDocs-TACC Project
- Create a repository from our
mkdocs-tacc-clienttemplate. How? - In your new repository:
- Rename
mkdocs_tacc_clientdirectory toyour_project_name. - Rename all instances of
TACC/mkdocs-tacc-clienttoYourOrgOrUser/your-repo-name. - In
pyproject.toml, change:- the
nametoyour-project-name - the
description - the
homepageURL
- the
- In
CONTRIBUTING.md, change:- the
[issues]:URL - the
[proposals]:URL
- the
- In
README.md, change the title.
- Rename
Install Theme Into Existing MkDocs Project
-
Enter the directory of your MkDocs project e.g.
cd path/to/your/mkdocs/project
-
Install the theme (and optional dependencies) e.g.
pip install "mkdocs-tacc[all]"
How to Use
-
In your
mkdocs.yml:- Set theme name as
tacc_readthedocs. - Set typical extensions for this theme.
- Set theme name as
Known Clients
| Status | Repository |
|---|---|
| Active | TACC-Docs |
| Active | digital-porous-media/dpm_docs |
| Active | DesignSafe-CI/DS-User-Guide |
| Potential | TACC/containers_at_tacc TACC/life_sciences_ml_at_tacc |
Contributing
We welcome contributions. Read "How to Contribute".
Metadata
Release files for mkdocs-tacc 1.0.5rc2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_tacc-1.0.5rc2.tar.gz | 29.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_tacc-1.0.5rc2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 67.3 kB
Release files / mkdocs_tacc-1.0.5rc2.tar.gz
| Download URL | mkdocs_tacc-1.0.5rc2.tar.gz |
|---|---|
| Size | 29.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8aeb9d126402f9cae3b88a29d4096ad3685c904acab84615f0cf6da42c8ed8c3
|
|
BLAKE2b-256 checksum How to use checksums |
e5a7b42030131d3cebd889d2e175d6174c9b0472f9516e9433d7447d85944967
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.12 Darwin/25.6.0
|
Release files / mkdocs_tacc-1.0.5rc2-py3-none-any.whl
| Download URL | mkdocs_tacc-1.0.5rc2-py3-none-any.whl |
|---|---|
| Size | 37.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6e5555d0235c5489d2a61c26f771b9007d5ec67e9df2ef5e9db61538192b5f19
|
|
BLAKE2b-256 checksum How to use checksums |
6668f0a66c7b0a2d8d4c779eea7abd43e0b93446f6bf4fc73875dcc05ae9161d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.12 Darwin/25.6.0
|
