-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make sphinx13 a re-usable theme #7733
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+0 for your proposal.
@@ -1,8 +1,8 @@ | |||
{# | |||
sphinxdoc/layout.html | |||
sphinx13/layout.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel strange for the name "sphinx13". It should be renamed if we make it public. But we've already used "sphinxdoc"...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't care about the name.
I was just trying to make a minimal change and fix obvious errors.
If you like to change the name, feel free to do so.
If you like me to change the name, please tell me the name you want to have.
I'm not planning on ever using this theme, so I don't really care whether it is available for common use. But I don't see any reason why not to make it re-usable. I think it may shine a negative light on Sphinx, because it may be perceived as if the Sphinx team thinks that none of the built-in themes are good enough for them. The main reason, however, why I made this PR, is for ease of maintenance. I was looking at all built-in themes and made #7689 and #7718 to fix some problems. Since the internal |
I did not object to remake it re-usable. Only my concern is its naming. I'm okay for not renaming it if we update it as a private theme. But we need to rename it to an appropriate one if we make it public. But I have no idea because "sphinxdoc" has been already used. It might be better to rename "sphinxdoc" to "oldsphinxdoc" and rename "sphinx13" to "sphinxdoc"... |
I don't think switching the theme associated with the name It looks like the name |
Indeed. I think "sphinxdoc" is a good new name for "sphinx13". But it has already been in use. So I don't have idea... sphinxdoc2? sphinxdoc-ng? I think making something public is like a contract. It is difficult to change it. So I'm afraid of use meaningless name for new theme. |
What about |
-1 to making There is an advantage to not making it public. It means that a small modification or destructive change won't affect it anywhere. This keeps maintenance costs low for maintainers. I'm sure there would be benefits to be gained by incorporating it into standard themes. However, if we make it a part of standard themes, we'll also have to adapt to new requests, which will increase maintainers costs. My suggestion is that someone should cut out the |
I find it strange that the Sphinx docs don't use one of Sphinx's own themes.
So I tried the convert the ad-hoc
sphinx13
theme (which was living indoc/_themes
) into a re-usable stand-alone theme (now living insphinx/themes
with all the other themes).I have marked this PR as "draft" because there is no documentation yet.
If this PR is considered for merging, I can add documentation (and any other things that are missing).