search

sphinx-themes / sphinx-themes.org

A showcase for Sphinx documentation themes
https://sphinx-themes.org
BSD 2-Clause "Simplified" License
233 stars 43 forks source link

New theme: <no PyPI name, from manticore-projects.com> #106

Closed manticore-projects closed 1 year ago

manticore-projects commented 1 year ago

Greetings!

I have been searching for a very long time for suitable theme, but did not really find anything pleasant: 1) most themes do not cater very wide screens well 2) color and styling is debatable 3) no landing page support

The nicest theme matching my taste is REVITRON, however it has technical shortcomings.

Long story short, I ended up with developing my own theme, forking from https://github.com/readthedocs/sphinx_rtd_theme

It scales very well on wide screens and mobile phones, it has a landing page, it supports 2 accent colors and it does not need NodeJS or NPM.

You can see it in action here: http://manticore-projects.com

image

At the moment, the theme is merely a Blob, which one would drop into the ./_themes folder. No PIP/Python involved or need.

Would you be interested in listing it? And what would you need from my end to make that happen please?

pradyunsg commented 1 year ago

Thanks for filing this issue! We'd be happy to list it! :)

See https://github.com/sphinx-themes/sphinx-themes.org/blob/master/CONTRIBUTING.md for the details on how to contribute new themes.

One notable requirement is that the theme needs to be pip installable and, typically, this also makes them usable by setting "just" the html_theme variable. See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package for the details on that.

manticore-projects commented 1 year ago

thank you for the heads up. I will work through accordingly.

pradyunsg commented 1 year ago

Awesome, when you have a PyPI name, please feel welcome to update this issue's title to reflect that. :)

manticore-projects commented 1 year ago

See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package for the details on that.

Apologies for asking, but this site does not seem to exist. https://www.sphinx-doc.org/en/master/development/theming.html?highlight=distribute#distribute-your-theme-as-a-python-package seems to work.

pradyunsg commented 1 year ago

Hey @manticore-projects! Any updates on this?

pradyunsg commented 1 year ago

Closing this out, since there don't seem to be any updates on this.