Skip to content

Bump ansys-sphinx-theme from 0.13.4 to 0.14.0 #51

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.

Sign up for GitHub

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

Merged
clatapie merged 6 commits into from
Feb 28, 2024
Merged

Bump ansys-sphinx-theme from 0.13.4 to 0.14.0 #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
83a8971
Bump ansys-sphinx-theme from 0.13.4 to 0.14.0
dependabot[bot] Feb 26, 2024
0530d20
Merge branch 'main' into dependabot/pip/ansys-sphinx-theme-0.14.0
clatapie Feb 27, 2024
6c394ce
Merge branch 'main' into dependabot/pip/ansys-sphinx-theme-0.14.0
clatapie Feb 27, 2024
4788930
maint: updating `sphinx-autoapi` version
clatapie Feb 28, 2024
103a910
fix: autoapi configuration
clatapie Feb 28, 2024
ce1ff05
fix: removing `install-deps` mention in Makefile
clatapie Feb 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,15 @@ help:

.PHONY: help Makefile

.install-deps:
@pip freeze | grep -q "sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi" && is_custom_sphinx_autoapi_installed="yes" || is_custom_sphinx_autoapi_installed="no"
@if [ "$$is_custom_sphinx_autoapi_installed" != "yes" ]; then \
pip uninstall --yes sphinx-autoapi; \
pip install "sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi@feat/single-page-stable"; \
fi

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: .install-deps Makefile
%: Makefile
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

clean:
rm -rf $(BUILDDIR)/*

pdf: .install-deps Makefile
pdf: Makefile
@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
(test -f $(BUILDDIR)/latex/ansys-engineeringworkflow-api-Documentation-*.pdf && echo pdf exists) || exit 1
7 changes: 0 additions & 7 deletions doc/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,6 @@ if "%1" == "" goto help
if "%1" == "clean" goto clean
if "%1" == "pdf" goto pdf

REM TODO: these lines of code should be removed once the feature branch is merged
for /f %%i in ('pip freeze ^| findstr /c:"sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi"') do set is_custom_sphinx_autoapi_installed=%%i
if NOT "%is_custom_sphinx_autoapi_installed%" == "sphinx-autoapi" (
pip uninstall --yes sphinx-autoapi
pip install "sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi@feat/single-page-stable")
REM TODO: these lines of code should be removed once the feature branch is merged

if "%1" == "linkcheck" goto linkcheck

%SPHINXBUILD% >NUL 2>NUL
Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@
suppress_warnings = ["autoapi.python_import_resolution"]
autoapi_python_use_implicit_namespaces = True
autoapi_render_in_single_page = ["class", "enum", "exception"]

autoapi_own_page_level = "class"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ dependencies = [

[project.optional-dependencies]
doc = [
"ansys-sphinx-theme==0.13.4",
"ansys-sphinx-theme==0.14.0",
"anyio==4.3.0",
"numpy==1.26.4",
"numpydoc==1.6.0",
Expand All @@ -40,7 +40,7 @@ doc = [
"sphinx-design==0.5.0",
"sphinx-gallery==0.15.0",
"sphinx-notfound-page==1.0.0",
"sphinx-autoapi==3.0.0", # "sphinx-autoapi @ git+https://github.com/jorgepiloto/sphinx-autoapi@feat/single-page-option", ---> Installed directly in workflow
"sphinx-autoapi==3.1.0a2",
"pytest-sphinx==0.6.0",
]

Expand Down