search

pytorch / pytorch_sphinx_theme

PyTorch Sphinx Theme
MIT License
96 stars 138 forks source link

pypi package? #105

Open turian opened 3 years ago

turian commented 3 years ago

Do you mind pushing a pypi release of this theme?

brianjo commented 3 years ago

@turian Hi Joseph, I'll take a look and see what that might entail. Thanks for the suggestion!

adamjstewart commented 3 years ago

The release at https://pypi.org/project/pytorch-sphinx-theme/ is broken and doesn't actually contain any of the release files. Would be great to have more stable releases.

turian commented 3 years ago

@adamjstewart related workaround for right now: https://pypi.org/project/unofficial-pt-lightning-sphinx-theme/

ain-soph commented 3 years ago

@turian

A better workaround might be 

pip install -e git+https://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme

as pytorch does in https://github.com/pytorch/pytorch/blob/master/docs/requirements.txt.

turian commented 3 years ago

@ain-soph I forget the exact reason why I sought a pypi package not github, I believe it was some Sphinx / RTFD requirement that precluded the use of github packages

ain-soph commented 3 years ago

@ain-soph I forget the exact reason why I sought a pypi package not github, I believe it was some Sphinx / RTFD requirement that precluded the use of github packages

If you don't mind, you may also take a look at my recent work to make pytorch_sphinx_theme a generic theme. It is deployed onto pypi automatically.
https://github.com/ain-soph/trojanzoo_sphinx_theme

With some minor visual changes, and a lot of javascripts improvements and bug fixes to make things smooth. The logos and all links are all customizable in your sphinx working repo, with some changes in conf.py.

See deployed demos at:
https://ain-soph.github.io/trojanzoo_sphinx_theme/

And my pytorch project docs using this theme https://ain-soph.github.io/trojanzoo/