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]"
[!NOTE] We also offer detailed instructions instead.
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.4
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.4.tar.gz | 29.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_tacc-1.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 67.4 kB
Release files / mkdocs_tacc-1.0.4.tar.gz
| Download URL | mkdocs_tacc-1.0.4.tar.gz |
|---|---|
| Size | 29.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9945a00aeb67ca27609d7a15e63e6495fe4bc404af1ac8ac4731507a814470db
|
|
BLAKE2b-256 checksum How to use checksums |
cb12325a90b5c60b6f6a2ab932759d6fbe8637ffd7aa719720ff65565342bb75
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.12 Darwin/25.5.0
|
Release files / mkdocs_tacc-1.0.4-py3-none-any.whl
| Download URL | mkdocs_tacc-1.0.4-py3-none-any.whl |
|---|---|
| Size | 37.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1029eafd35b9996e19fb560aae9d1174d4262e1e3a3c3c5ed3518f7d5cd0a16a
|
|
BLAKE2b-256 checksum How to use checksums |
7c59d670f69ae4a92cacaa814aae8487dca287fcbd66940fda26a85faffa744f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.12 Darwin/25.5.0
|
