Move theme options to a custom sphinx theme #41
Conversation
Maetveis
force-pushed
the
factor_out_theme
branch
from
e12c8f8 to
0ce7542
Compare
|
This looks excellent to me, I do have one question about the |
Yes, since this PR doesn't move all settings to the new theme only the "theming related" ones, like the custom templates css, logos etc. I have not moved the favicon setting or the one that disables the sphinx logo, as they are not strictly
I think I should move that one over.
Yes, partly. The idea would be to split the current method to several sphinx extensions, the first of which is this theme, users that only need the theme are now able to specify Backwards compatibility can be kept by making the current method enable these new extensions and setting their settings, and finally that can be dropped at a later time requiring users to instead specify the extensions they want to use. |
As part of making rocm-docs-core a sphinx extension, move its theming settings to a sphinx theme `rocm_docs_theme`. This makes it easier to re-use. Also, the theme files no longer need to be copied to the documentation directory keeping things a little tidier. This change is transparent to users because `setup()` sets the sphinx theme to this new bundled theme.
Maetveis
force-pushed
the
factor_out_theme
branch
from
0ce7542 to
575f1c5
Compare
This reverts commit 955105a.
|
@Maetveis This caused the following error when building on ReadTheDocs: |
Ah, this is seems like it popped up since I last built this 😓 , it looks like its this: issue pydata/pydata-sphinx-theme#1274. I'll see if the suggested solution there works for us. It might require regenerating the lock-files (requirements.txt) however. |
|
I wonder how that even happened when supposedly we have our packages pinned in every repository. |
rocm-docs-core itself is not pinned, as it was changing quite often for a time and during early development it was convenient to not have it pinned, which may have contributed?. However we've reached the point where we should be pinning rocm-docs-core versions. |
As part of making rocm-docs-core a sphinx extension, move its theming settings to a sphinx theme `rocm_docs_theme`. This makes it easier to re-use. Also, the theme files no longer need to be copied to the documentation directory keeping things a little tidier. This change is transparent to users because `setup()` sets the sphinx theme to this new bundled theme. Re-land with fix and requirement for pydata-sphinx-theme 13.3
As part of making rocm-docs-core a sphinx extension, move its theming settings to a sphinx theme `rocm_docs_theme`. This makes it easier to re-use. Also, the theme files no longer need to be copied to the documentation directory keeping things a little tidier. This change is transparent to users because `setup()` sets the sphinx theme to this new bundled theme. Re-land with fix and requirement for pydata-sphinx-theme 13.3
* Move theme settings to a custom sphinx theme (#41) As part of making rocm-docs-core a sphinx extension, move its theming settings to a sphinx theme `rocm_docs_theme`. This makes it easier to re-use. Also, the theme files no longer need to be copied to the documentation directory keeping things a little tidier. This change is transparent to users because `setup()` sets the sphinx theme to this new bundled theme. Re-land with fix and requirement for pydata-sphinx-theme 13.3 * Migrate setup.cfg to pyproject.toml Having just the standard package metadata simplifies things, tools were sometimes preferring one over the other creating confusion. Additionally fix the theme folder not being installed * Add readthedocs build Add a readthedocs build mostly to verify that the package works, without needing to create a PR in a dependent repository. * Make theme settings overrideable Respect any user defined settings and only provide defaults. - Move simple defaults to theme.conf, user settings override it by default - And prefer the users value for the more complex ones * Move the rest of the visual settings into the theme Moves the favicon and hiding the sphinx logo into theme, and provide only a default value (users can now override), * ci(lint): Add commit message linting via commitizen The commits of pull requests are now checked with commitizen to conform to conventional commits format. * ci(release): Add automatic version bump and pypi release Implement automatic version bumps based on commitizen, every push to main triggers a bump if a new feature/fix is added. The new release is automatically built and published to pypi. * docs(developer_guide): add short summary of committing rules, commitizen usage
As part of making rocm-docs-core a sphinx extension, move its theming settings to a sphinx theme
rocm_docs_theme. This makes it easier to re-use. Also, the theme files no longer need to be copied to the documentation directory keeping things a little tidier.This change is transparent to users because
setup()sets the sphinx theme to this new bundled theme.