Registry / web-framework / pytorch-sphinx-theme

pytorch-sphinx-theme

library0.0.19pypypi✓ verified 86d ago

PyTorch Sphinx Theme is a Sphinx theme used in PyTorch documentation. The current version is 0.4.9, with release cadence on demand. It provides a consistent look and feel for PyTorch-related documentation projects.

web-framework

pip install pytorch-sphinx-theme

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PYTORCH-SPHINX-THE

pytorch-sphinx-theme

web-frameworkpythonv0.0.19

Install

5.3s avg

Import

—

Disk

94MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.0.19 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 92.3MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.3s · import 0.000s · 93MB

94MB installed

● package 94MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

PyTorchSphinxTheme

✓ from pytorch_sphinx_theme import __version__

Importing the version string is a common pattern.

Basic configuration to use the theme in Sphinx docs.

# conf.py import pytorch_sphinx_theme html_theme = 'pytorch_sphinx_theme' html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()]

Debug

Known issues

gotchaDo not use 'pytorch-sphinx-theme' in html_theme; use the string 'pytorch_sphinx_theme' (underscores, not hyphens).

fix

Set html_theme = 'pytorch_sphinx_theme'.

affects: all

deprecatedThe package 'pytorch-sphinx-theme' was renamed from 'pytorch_sphinx_theme' on PyPI. The import remains 'pytorch_sphinx_theme', but ensure you install the correct package.

fix

Install 'pytorch-sphinx-theme' from PyPI.

affects: >=0.4.0

gotchaThe theme requires Sphinx >= 1.6, but some features may not work with Sphinx >= 4.0 without additional configuration.

fix

Check compatibility with your Sphinx version.

affects: all

Errors

Common errors & fixes

pytorch_sphinx_theme.get_html_theme_path() AttributeError: module 'pytorch_sphinx_theme' has no attribute 'get_html_theme_path'

The function get_html_theme_path was removed in newer versions (0.4.x) or may not be available.

fix

Use html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()] only for older versions; for 0.4.x, set html_theme = 'pytorch_sphinx_theme' and let Sphinx handle the path automatically.

ModuleNotFoundError: No module named 'pytorch_sphinx_theme'

You installed 'pytorch-sphinx-theme' but the import path is 'pytorch_sphinx_theme' (hyphen vs underscore). It's correct; if the error persists, reinstall the package.

fix

pip install pytorch-sphinx-theme # installs the package; import as pytorch_sphinx_theme

Theme 'pytorch_sphinx_theme' not found

The html_theme is set incorrectly or the theme is not installed in the Sphinx environment.

fix

Ensure you have installed pytorch-sphinx-theme and set html_theme = 'pytorch_sphinx_theme' (underscores).

Upgrade

Version history

0.0.19latest on PyPI · released Sep 14, 2018

Audit

Dependencies

No dependency data recorded yet.

Agent activity

7 hits · last 30 days

node

Resources

githubhttps://github.com/shiftlab/pytorch_sphinx_theme ↗

packagehttps://pypi.org/project/pytorch-sphinx-theme/ ↗

homepagehttps://pytorch.org ↗