Skip to content

Conversation

@Revathyvenugopal162
Copy link
Contributor

@Revathyvenugopal162 Revathyvenugopal162 commented Mar 4, 2025

fix #634

  • Migrate the theme builder to sphinx theme builder
  • cleanup the pyproject.toml file
  • Add package.json and package.json.lock file as part of build system
  • Change the order of changelog types

@github-actions github-actions bot added the css Requires or modifies cascading style sheets label Mar 5, 2025
@github-actions
Copy link

github-actions bot commented Mar 5, 2025

The towncrier template has been successfully rewritten with the default template.
Please ensure that sphinx-design is included as a dependency in your project's documentation requirements.
Additionally, add sphinx-design to the extensions list in your conf.py file.
For more information, please refer to the migration guide at:
https://actions.docs.ansys.com/version/stable/migrations/index.html#migration-guide

@Revathyvenugopal162 Revathyvenugopal162 added the maintenance Generic maintenance related label Mar 5, 2025
@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as ready for review March 5, 2025 15:21
@Revathyvenugopal162 Revathyvenugopal162 requested a review from a team as a code owner March 5, 2025 15:21
Copy link
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just left some comments regarding Node.js and the build system versions.

Comment on lines 2 to 4
requires = [
"sphinx-theme-builder @ https://github.com/pradyunsg/sphinx-theme-builder/archive/87214d0671c943992c05e3db01dca997e156e8d6.zip",
]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason for this particular commit? Why not pointing to the latest stable version?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I initially encountered an infinite loop while testing with another package, possibly due to an oversight when adapting from PyData. I'll test the latest release again and make the necessary adjustments.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this going to prevent us from releasing? I know PyPI doesn't like links to repositories as dependencies

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i updated to latest version, working with my tox env, (may be issue is only with nox env)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you elaborate more about this issue, @Revathyvenugopal162?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, STB can run the docs live using the command stb serve doc/source/ --open-browser. However, I encountered an issue where it was stuck in an infinite loop, preventing the browser from opening and running it properly. I referred to other themes and noticed they were using a specific commit. After testing with Tox, it worked fine, so the issue might be related to my environment or possibly the Nox environment.

Copy link
Contributor Author

@Revathyvenugopal162 Revathyvenugopal162 Mar 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i will open another PR to add docs-preview in tox env, but the issue persists when using Sphinx-Gallery with build_example = True, causing the docs to enter an infinite loop.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR : #642

Co-authored-by: Roberto Pastor Muela <[email protected]>
Copy link
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super cool! Thanks, @Revathyvenugopal162.

@Revathyvenugopal162 Revathyvenugopal162 merged commit c9ffb83 into main Mar 6, 2025
23 checks passed
@Revathyvenugopal162 Revathyvenugopal162 deleted the maint/change-builder branch March 6, 2025 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

css Requires or modifies cascading style sheets maintenance Generic maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate the build system to sphinx-theme-builder

5 participants