File tree Expand file tree Collapse file tree 4 files changed +5
-19
lines changed
Expand file tree Collapse file tree 4 files changed +5
-19
lines changed Original file line number Diff line number Diff line change @@ -13,22 +13,15 @@ help:
1313
1414.PHONY : help Makefile
1515
16- .install-deps :
17- @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"
18- @if [ " $$ is_custom_sphinx_autoapi_installed" != " yes" ]; then \
19- pip uninstall --yes sphinx-autoapi; \
20- pip install " sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi@feat/single-page-stable" ; \
21- fi
22-
2316# Catch-all target: route all unknown targets to Sphinx using the new
2417# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
25- % : .install-deps Makefile
18+ % : Makefile
2619 $(SPHINXBUILD ) -M $@ " $( SOURCEDIR) " " $( BUILDDIR) " $(SPHINXOPTS ) $(O )
2720
2821clean :
2922 rm -rf $(BUILDDIR ) /*
3023
31- pdf : .install-deps Makefile
24+ pdf : Makefile
3225 @$(SPHINXBUILD ) -M latex " $( SOURCEDIR) " " $( BUILDDIR) " $(SPHINXOPTS ) $(O )
3326 cd $(BUILDDIR ) /latex && latexmk -r latexmkrc -pdf * .tex -interaction=nonstopmode || true
3427 (test -f $( BUILDDIR) /latex/ansys-engineeringworkflow-api-Documentation-* .pdf && echo pdf exists) || exit 1
Original file line number Diff line number Diff line change @@ -14,13 +14,6 @@ if "%1" == "" goto help
1414if " %1 " == " clean" goto clean
1515if " %1 " == " pdf" goto pdf
1616
17- REM TODO: these lines of code should be removed once the feature branch is merged
18- 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
19- if NOT " %is_custom_sphinx_autoapi_installed% " == " sphinx-autoapi" (
20- pip uninstall --yes sphinx-autoapi
21- pip install " sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi@feat/single-page-stable" )
22- REM TODO: these lines of code should be removed once the feature branch is merged
23-
2417if " %1 " == " linkcheck" goto linkcheck
2518
2619%SPHINXBUILD% > NUL 2 > NUL
Original file line number Diff line number Diff line change 136136suppress_warnings = ["autoapi.python_import_resolution" ]
137137autoapi_python_use_implicit_namespaces = True
138138autoapi_render_in_single_page = ["class" , "enum" , "exception" ]
139-
139+ autoapi_own_page_level = "class"
140140
141141# The language for content autogenerated by Sphinx. Refer to documentation
142142# for a list of supported languages.
Original file line number Diff line number Diff line change @@ -30,7 +30,7 @@ dependencies = [
3030
3131[project .optional-dependencies ]
3232doc = [
33- " ansys-sphinx-theme==0.13.4 " ,
33+ " ansys-sphinx-theme==0.14.0 " ,
3434 " anyio==4.3.0" ,
3535 " numpy==1.26.4" ,
3636 " numpydoc==1.6.0" ,
@@ -40,7 +40,7 @@ doc = [
4040 " sphinx-design==0.5.0" ,
4141 " sphinx-gallery==0.15.0" ,
4242 " sphinx-notfound-page==1.0.0" ,
43- " sphinx-autoapi==3.0.0 " , # "sphinx-autoapi @ git+https://github.com/jorgepiloto/sphinx-autoapi@feat/single-page-option", ---> Installed directly in workflow
43+ " sphinx-autoapi==3.1.0a2 " ,
4444 " pytest-sphinx==0.6.0" ,
4545]
4646
You can’t perform that action at this time.
0 commit comments