-
Notifications
You must be signed in to change notification settings - Fork 8
feat: migrate the builds system to stb #639
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
Changes from 13 commits
bf9fb14
cd60c62
6eb8a24
2627b3d
66da7a9
797a7c7
1771f03
fd6daae
f6543c0
60fb034
664c12f
2c2d9b7
822908d
2354e10
6fc4798
b6aa45f
e9ef432
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| feat: migrate the builds system to stb |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,22 @@ | ||
| {% if sections[""] %} | ||
| {% for category, val in definitions.items() if category in sections[""] %} | ||
|
|
||
| {{ definitions[category]['name'] }} | ||
| {% set underline = '^' * definitions[category]['name']|length %} | ||
| {{ underline }} | ||
|
|
||
| {% for text, values in sections[""][category].items() %} | ||
| - {{ text }} {{ values|join(', ') }} | ||
| {% endfor %} | ||
|
|
||
| {% endfor %} | ||
| {% else %} | ||
| No significant changes. | ||
|
|
||
|
|
||
| {% endif %} | ||
| {% if sections[""] %} | ||
|
|
||
| .. tab-set:: | ||
|
|
||
| {%+ for category, val in definitions.items() if category in sections[""] %} | ||
|
|
||
| .. tab-item:: {{ definitions[category]['name'] }} | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 0 | ||
| :widths: auto | ||
|
|
||
| {% for text, values in sections[""][category].items() %} | ||
| * - {{ text }} | ||
| - {{ values|join(', ') }} | ||
|
|
||
| {% endfor %} | ||
| {% endfor %} | ||
|
|
||
| {% else %} | ||
| No significant changes. | ||
| {% endif %} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
jorgepiloto marked this conversation as resolved.
Show resolved
Hide resolved
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "name": "ansys_sphinx_theme", | ||
| "repository": "https://github.com/ansys/ansys-sphinx-theme", | ||
|
|
||
| "description": "", | ||
| "main": "", | ||
| "scripts": { | ||
| "build": "echo 'No build step needed' " | ||
| }, | ||
| "dependencies": {}, | ||
| "devDependencies": {} | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,12 @@ | ||
| [build-system] | ||
| requires = ["flit_core >=3.2,<4"] | ||
| build-backend = "flit_core.buildapi" | ||
| requires = [ | ||
| "sphinx-theme-builder @ https://github.com/pradyunsg/sphinx-theme-builder/archive/87214d0671c943992c05e3db01dca997e156e8d6.zip", | ||
| ] | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good point.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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)
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you elaborate more about this issue, @Revathyvenugopal162?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, STB can run the docs live using the command
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PR : #642 |
||
| build-backend = "sphinx_theme_builder" | ||
|
|
||
| [tool.sphinx-theme-builder] | ||
| node-version = "22.9.0" | ||
Revathyvenugopal162 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| theme-name = "ansys_sphinx_theme" | ||
|
|
||
| [project] | ||
| # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections | ||
|
|
@@ -63,19 +69,7 @@ changelog = [ | |
| ] | ||
|
|
||
| [project.entry-points."sphinx.html_themes"] | ||
| ansys_sphinx_theme = "ansys_sphinx_theme" | ||
|
|
||
| [tool.flit.module] | ||
| name = "ansys_sphinx_theme" | ||
|
|
||
| [tool.flit.sdist] | ||
| include = [ | ||
| "src/ansys_sphinx_theme/theme/ansys_sphinx_theme/layout.html", | ||
| "src/ansys_sphinx_theme/theme/ansys_sphinx_theme/components/breadcrumbs.html", | ||
| "src/ansys_sphinx_theme/theme/ansys_sphinx_theme/theme.conf", | ||
| "src/ansys_sphinx_theme/theme/ansys_sphinx_theme/_templates/", | ||
| "src/ansys_sphinx_theme/theme/ansys_sphinx_theme/static/", | ||
| ] | ||
| "ansys_sphinx_theme" = "ansys_sphinx_theme" | ||
|
|
||
| [project.urls] | ||
| Home = "https://sphinxdocs.ansys.com/" | ||
|
|
@@ -147,18 +141,18 @@ name = "Fixed" | |
| showcontent = true | ||
|
|
||
| [[tool.towncrier.type]] | ||
| directory = "dependencies" | ||
| name = "Dependencies" | ||
| directory = "documentation" | ||
| name = "Documentation" | ||
| showcontent = true | ||
|
|
||
| [[tool.towncrier.type]] | ||
| directory = "miscellaneous" | ||
| name = "Miscellaneous" | ||
| directory = "test" | ||
| name = "Test" | ||
| showcontent = true | ||
|
|
||
| [[tool.towncrier.type]] | ||
| directory = "documentation" | ||
| name = "Documentation" | ||
| directory = "dependencies" | ||
| name = "Dependencies" | ||
| showcontent = true | ||
|
|
||
| [[tool.towncrier.type]] | ||
|
|
@@ -167,6 +161,6 @@ name = "Maintenance" | |
| showcontent = true | ||
|
|
||
| [[tool.towncrier.type]] | ||
| directory = "test" | ||
| name = "Test" | ||
| showcontent = true | ||
| directory = "miscellaneous" | ||
| name = "Miscellaneous" | ||
| showcontent = true | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,3 @@ | ||
| @import "ansys-sphinx-theme-variable.css"; | ||
|
|
||
| .static-search-results { | ||
| display: flex; | ||
| flex-direction: column; | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,3 @@ | ||
| @import "ansys-sphinx-theme-variable.css"; | ||
|
|
||
| /** | ||
| * Sphinx gallery output cell | ||
| */ | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.