diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 1827c0fad2..50fa309c7b 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -102,9 +102,6 @@ jobs: PYPRIMEMESH_SPHINX_BUILD: 1 PYPRIMEMESH_IMAGE_TAG: ${{ env.DOCKER_IMAGE_TAG }} ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER )}} - with: - # By default, also '-W --keep-going'... we should eventually solve the warnings in the build process. - sphinxopts: '-j auto' testing: name: Run Unit Tests diff --git a/doc/source/conf.py b/doc/source/conf.py index 742a82b292..7b19db6bfe 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -60,11 +60,11 @@ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', "numpydoc", + "notfound.extension", "sphinx.ext.intersphinx", "sphinx_copybutton", "sphinx_gallery.gen_gallery", "jupyter_sphinx", - "notfound.extension", "sphinx.ext.coverage", "sphinx.ext.doctest", "sphinx.ext.extlinks", @@ -74,7 +74,7 @@ # Intersphinx mapping intersphinx_mapping = { - "python": ("https://docs.python.org/dev", None), + "python": ("https://docs.python.org/3", None), # kept here as an example # "scipy": ("https://docs.scipy.org/doc/scipy/reference", None), # "numpy": ("https://numpy.org/devdocs", None), diff --git a/examples/gallery/08_lucid_generic_f1_rear_wing.py b/examples/gallery/08_lucid_generic_f1_rear_wing.py index 4dbb602e9c..03018a0155 100644 --- a/examples/gallery/08_lucid_generic_f1_rear_wing.py +++ b/examples/gallery/08_lucid_generic_f1_rear_wing.py @@ -78,7 +78,7 @@ ############################################################################### # Merge parts -# ~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~ # Establish the global size parameter to regulate mesh refinement. # Merge all individual parts into a unified part named `f1_car_rear_wing`. @@ -96,7 +96,7 @@ ############################################################################### # Mesh connect -# ~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~ # In order to generate a volume mesh for a closed domain, it is necessary to ensure # that the components of the rear wing are properly connected. # To achieve this, perform a connect operation using labels to join the components of @@ -119,7 +119,7 @@ ############################################################################### # Define local size-control and generate size-field -# ~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ # In order to accurately represent the physics of the DRS wing, a limitation of 8 mm # is imposed on the mesh size of the wing. # This is accomplished by implementing curvature size control, which refines the @@ -165,7 +165,7 @@ ############################################################################### # Generate surface mesh -# ~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~~~~~~~ # Create a surface mesh for the rear wing using the defined size controls. # To facilitate the definition of boundary conditions on the surfaces in the solver, # generate face zones by utilizing the existing labels found in the rear wing model. @@ -180,14 +180,14 @@ ############################################################################### # Compute volumetric regions -# ~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~~~~~~~~~~~~ # Compute the volume zones. mesh_util.compute_volumes(part_expression=part.name, create_zones_per_volume=True) ############################################################################### # Define volume controls -# ~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~~~~~~~~ # In order to prevent the generation of a volume mesh within the solid wing, # the type of a volume zone within the rear wing can be defined as "dead". # To accomplish this, Volume Control is utilized to assign the type for the @@ -211,7 +211,7 @@ ############################################################################### # Define prism controls -# ~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~~~~~~~ # A prism control can be used to define inflation layers on the external aero surfaces. # Specify the aero surfaces using labels, here prism scope is defined on zones associated # with labels ``*drs*`` and ``*plane*``. @@ -247,7 +247,7 @@ ############################################################################### # Generate volume mesh -# ~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~~~~~~ # Volume mesh with hexcore polyhedral elements and boundary layer refinement. volume_mesh = prime.AutoMesh(model) diff --git a/examples/misc/example_template.py b/examples/misc/example_template.py index b85e45474f..2a39869e12 100644 --- a/examples/misc/example_template.py +++ b/examples/misc/example_template.py @@ -84,9 +84,9 @@ # as ReStructured Text (RST). # # .. note:: -# You only need to create the Python (PY) files for the example. The -# ``sphinx-gallery`` extension automatically generates the Jupyter -# notebook, the HTML files for the documentation, and the demo script. +# You only need to create the Python (PY) files for the example. The +# ``sphinx-gallery`` extension automatically generates the Jupyter +# notebook, the HTML files for the documentation, and the demo script. # # Sections can contain any information that you may have regarding the example, # such as step-by-step comments and information on motivations. In the generated diff --git a/pyproject.toml b/pyproject.toml index 23e2743ebf..92851658de 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,15 +40,15 @@ tests = [ "pyvista[trame]==0.41.1" ] doc = [ - "ansys-sphinx-theme==0.10.2", + "ansys-sphinx-theme @ git+https://github.com/ansys/ansys-sphinx-theme.git@fix/edit-this-context", "jupyter-sphinx==0.4.0", "numpydoc==1.5.0", - "Sphinx==7.1.2", + "Sphinx==7.2.4", "pyvista==0.41.1", "sphinx-autodoc-typehints==1.24.0", "sphinx-copybutton==0.5.2", - "sphinx-gallery==0.13.0", - "sphinx-notfound-page==0.8.3", + "sphinx-gallery==0.14.0", + "sphinx-notfound-page==1.0.0", "sphinxemoji==0.2.0", ] all = [