Skip to content

WIP: fix docs build #211

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
+11 −25
Draft

WIP: fix docs build #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f42012a
Remove forced install of ansys sphinx-autoapi fork
femarchi Nov 25, 2025
3773ba6
Minor fixes in index files
femarchi Nov 25, 2025
fafc16d
Bump Sphinx to 8.2.3
femarchi Nov 27, 2025
f734471
Fix sphinx autoapi extension not loading api reference template
femarchi Nov 27, 2025
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
7 changes: 0 additions & 7 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,6 @@ 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).
%: Makefile
Expand Down
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 @@ -10,13 +10,6 @@ if "%SPHINXBUILD%" == "" (
set SOURCEDIR=source
set BUILDDIR=_build

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" == "" goto help
if "%1" == "clean" goto clean
if "%1" == "pdf" goto pdf
Expand Down
13 changes: 8 additions & 5 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
from ansys.rocky.core import __version__

# Project information
project = "pyrocky"
project = "ansys-rocky-core"
copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
author = "ANSYS, Inc."
release = version = __version__
Expand All @@ -26,6 +26,9 @@
html_theme = "ansys_sphinx_theme"
html_short_title = html_title = "pyrocky"

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# specify the location of your github repo
html_theme_options = {
"github_url": "https://github.com/ansys/pyrocky",
Expand All @@ -39,10 +42,12 @@
"version_match": get_version_match(version),
},
"check_switcher": False,
"ansys_sphinx_theme_autoapi": {"project": project},
}

# Sphinx extensions
extensions = [
"ansys_sphinx_theme.extension.autoapi",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"numpydoc",
Expand Down Expand Up @@ -128,13 +133,11 @@
"show-module-summary",
"special-members",
]
autoapi_template_dir = get_autoapi_templates_dir_relative_path(Path(__file__))
autoapi_template_dir = get_autoapi_templates_dir_relative_path(Path(__file__).parent)
suppress_warnings = ["autoapi.python_import_resolution"]
autoapi_python_use_implicit_namespaces = True
autoapi_keep_files = True
autoapi_render_in_single_page = ["class", "enum", "exception"]

# PyAnsys tags configuration
html_context = {
"pyansys_tags": ['Fluids']
}
html_context = {"pyansys_tags": ["Fluids"]}
3 changes: 0 additions & 3 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,6 @@ the most powerful DEM (discrete element method) software in the market.

Explore end-to-end examples that show how to use PyRocky.

.. toctree::
:hidden:
:maxdepth: 3
.. toctree::
:hidden:
:maxdepth: 3
Expand Down
1 change: 1 addition & 0 deletions doc/source/user_guide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
User guide
==========

Use Rocky PrePost Scripting

Check warning on line 7 in doc/source/user_guide/index.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/user_guide/index.rst#L7 

[Google.Headings] 'Use Rocky PrePost Scripting' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Use Rocky PrePost Scripting' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide/index.rst", "range": {"start": {"line": 7, "column": 1}}}, "severity": "WARNING"}
---------------------------

In its current form, PyRocky is a thin layer that enables remote calls to Rocky using the
Expand All @@ -13,6 +13,7 @@

.. vale off
.. code:: python

rocky = pyrocky.launch_rocky()
api = rocky.api

Expand Down
5 changes: 2 additions & 3 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,9 @@ tests = [
"requests==2.32.5",
]
doc = [
"ansys-sphinx-theme==1.6.3",
"ansys-sphinx-theme[autoapi]==1.6.3",
"numpydoc==1.9.0",
"Sphinx==8.1.3",
"sphinx-autoapi==3.6.1",
"Sphinx==8.2.3",
"sphinx-copybutton==0.5.2",
"sphinx-gallery==0.19.0",
"sphinx-design==0.6.1",
Expand Down
Loading