Metadata-Version: 2.3
Name: mkdocs-tacc
Version: 0.6.2
Summary: TACC-specific MkDocs theme
License: MIT License
         
         Copyright (c) 2023 Texas Advanced Computing Center (TACC)
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Author: TACC COA CMD
Author-email: coa-cmd@tacc.utexas.edu
Maintainer: TACC COA CMD
Maintainer-email: coa-cmd@tacc.utexas.edu
Requires-Python: >=3.10,<3.13
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: MkDocs
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: BSD License
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation
Provides-Extra: all
Provides-Extra: i18n
Provides-Extra: pymdown-extensions
Requires-Dist: mkdocs (==1.4.3)
Requires-Dist: mkdocs[i18n] (==1.4.3) ; extra == "all"
Requires-Dist: mkdocs[i18n] (==1.4.3) ; extra == "i18n"
Requires-Dist: pymdown-extensions (>=10.4.0) ; extra == "all"
Requires-Dist: pymdown-extensions (>=10.4.0) ; extra == "pymdown-extensions"
Project-URL: Documentation, https://tacc.github.io/mkdocs-tacc
Project-URL: Homepage, https://tacc.github.io/mkdocs-tacc
Project-URL: changelog, https://github.com/TACC/mkdocs-tacc/releases
Project-URL: github, https://github.com/TACC/mkdocs-tacc
Project-URL: issues, https://github.com/TACC/mkdocs-tacc/issues
Description-Content-Type: text/markdown

# MkDocs TACC Theme

A [TACC](https://www.tacc.utexas.edu/)-styled [MkDocs](https://www.mkdocs.org/) theme based on **MkDocs**' own [ReadTheDocs theme](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs).

- **Either** [Create a New MkDocs-TACC Project](#create-a-new-mkdocs-tacc-project)
- **Or** [Install Theme Into Existing MkDocs Project](#install-theme-into-existing-mkdocs-project)

## Create a New MkDocs-TACC Project

1. Create a repository from our [`mkdocs-tacc-client`](https://github.com/TACC/mkdocs-tacc-client) template. [How?][create-from-template]
2. In your new repository:
    - Change [all instances of `mkdocs-tacc-client`](https://github.com/search?q=repo%3ATACC%2Fmkdocs-tacc-client+%22mkdocs-tacc-client%22&type=code) to `your-project-name`.
    - Change [all instances of `MkDocs-TACC`](https://github.com/search?q=repo%3ATACC%2Fmkdocs-tacc-client%20%22MkDocs-TACC%22&type=code) to `Your Project Name`.
    - Rename [`mkdocs_tacc_client` directory](https://github.com/TACC/mkdocs-tacc-client/tree/main/mkdocs_tacc_client) to `your_project_name`.

## Install Theme Into Existing MkDocs Project

1. Enter the directory of your MkDocs project e.g.

    ```shell
    cd path/to/your/mkdocs/project
    ```

2. Install the theme (and optional dependencies) e.g.

    ```shell
    pip install "mkdocs-tacc[all]"
    ```

> [!NOTE]
> We also offer [detailed instructions](https://tacc.github.io/mkdocs-tacc/) instead.

## How to Use

3. In your `mkdocs.yml`:

    - Set theme name as `tacc_readthedocs`.
    - Set [typical extensions for this theme](./docs/extensions.md#typical).

## Known Clients

| Status | Repository |
| - | - |
| Active | [TACC-Docs](https://github.com/TACC/TACC-Docs)<br>[digital-porous-media/dpm_docs](https://github.com/digital-porous-media/dpm_docs) |
| Upcoming | [DesignSafe-CI/DS-User-Guide](https://github.com/DesignSafe-CI/DS-User-Guide) |
| Potential | [TACC/containers_at_tacc](https://github.com/TACC/containers_at_tacc)<br>[TACC/life_sciences_ml_at_tacc](https://github.com/TACC/life_sciences_ml_at_tacc) |

## Contributing

We welcome contributions. Read ["How to Contribute"](./CONTRIBUTING.md).

[create-from-template]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template

