pytorch_sphinx_theme icon indicating copy to clipboard operation
pytorch_sphinx_theme copied to clipboard

[Request] To convert this theme into a generic sphinx theme

Open MrinalJain17 opened this issue 5 years ago • 3 comments

As of now, there are only a handful of themes for sphinx that are both functional and visually pleasing. The theme developed for the new layout of pytorch docs and tutorials (for version 1.0) is quite elegant, and it would be great if this theme could be converted into a generic sphinx theme, making it possible for anyone to use it.

Or perhaps, if there is a workaround to do this?

For example,

If I wanted to use the pytorch_sphinx_theme, I could

pip install pytorch_sphinx_theme

Then in my conf.py,

html_theme = "pytorch_sphinx_theme"

MrinalJain17 avatar Sep 23 '18 10:09 MrinalJain17

Poking through the source code it doesn't appear to have many PyTorch specific end points. I haven't tried this and just started to look into trying this out as a theme as well. What are the issues with including this in other projects?

dgasmith avatar Feb 27 '19 14:02 dgasmith

I believe fixing #143 is also required to make this a generic theme.

adamjstewart avatar Sep 22 '21 15:09 adamjstewart

Maybe you could take a look at my recent work, which removes all pytorch-related things and support many customizations. It also removes all other unnecessary items to make it a pure doc template.

https://github.com/ain-soph/trojanzoo_sphinx_theme

demo

https://ain-soph.github.io/trojanzoo_sphinx_theme/
https://ain-soph.github.io/alsplot/

ain-soph avatar Oct 04 '21 16:10 ain-soph