https://github.com/wesleyboar/sphinx_tacc_theme
The documentation theme for Sphinx at TACC
https://github.com/wesleyboar/sphinx_tacc_theme
documentation readthedocs sphinx tacc theme
Last synced: about 1 year ago
JSON representation
The documentation theme for Sphinx at TACC
- Host: GitHub
- URL: https://github.com/wesleyboar/sphinx_tacc_theme
- Owner: wesleyboar
- Created: 2025-03-24T18:07:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-24T18:29:42.000Z (over 1 year ago)
- Last Synced: 2025-03-24T19:32:36.751Z (over 1 year ago)
- Topics: documentation, readthedocs, sphinx, tacc, theme
- Language: Python
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TACC Sphinx Theme
A [TACC](https://www.tacc.utexas.edu/)-styled [Sphinx](https://www.sphinx-doc.org/) theme based on **ReadTheDocs**'s own [Sphinx theme](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/README.rst).
## How to Install
> [!CAUTION]
> **Not published yet.**
>
> 1. Install the theme e.g.
>
> ```bash
> pip install sphinx-tacc-theme
> ```
> [!IMPORTANT]
> **Development method.**
>
> 1. Install the theme e.g.
>
> ```bash
> pip install -e "sphinx-tacc-theme @git+https://github.com/TACC/sphinx-tacc-theme.git"
> ```
2. In your `conf.py`:
- Add theme `sphinx_tacc_theme`:
```python
import sphinx_tacc_theme
html_theme = "sphinx_tacc_theme"
```
- Set [typical extensions for this theme](./docs/extensions.md#typical).
Not yet certain to be documented.
> [!NOTE]
> We also do not yet offer detailed instructions instead.
## Known Clients
| Status | Repository |
| - | - |
| Active | |
| Upcoming | [TACC/life_sciences_ml_at_tacc](https://github.com/TACC/life_sciences_ml_at_tacc) |
| Potential | [TACC/containers_at_tacc](https://github.com/TACC/containers_at_tacc) |
## Contributing
We welcome contributions. Read ["How to Contribute"](./CONTRIBUTING.md).
We do not yet offer guidance on how to contribute.