Consolidate nightly and PR doc builds

.github/workflows/ci.yml

@@ -132,7 +132,7 @@ jobs:
       - name: Build Documentation
         run: |
           pip install -r requirements_docs.txt         
-          xvfb-run make -C doc html SPHINXOPTS="-v"
+          xvfb-run make -C doc html
           touch doc/_build/html/.nojekyll
           echo "fluentdocs.pyansys.com" >> doc/_build/html/CNAME
         env:

.github/workflows/nightly-doc-build.yml

@@ -46,7 +46,7 @@ jobs:
       - name: Build Documentation
         run: |
           pip install -r requirements_docs.txt
-          make -C doc html
+          xvfb-run make -C doc html
           touch doc/_build/html/.nojekyll
           echo "dev.fluentdocs.pyansys.com" >> doc/_build/html/CNAME
         env:

doc/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -j auto -W --keep-going -w build_errors.txt -N
+SPHINXOPTS    = -v -j auto -W --keep-going -w build_errors.txt -N
 SPHINXBUILD   = sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = _build

doc/make.bat

@@ -11,7 +11,7 @@ if "%SPHINXBUILD%" == "" (
 )
 set SOURCEDIR=source
 set BUILDDIR=_build
-set SPHINXOPTS=-j auto -W --keep-going -w build_errors.txt -N
+set SPHINXOPTS=-v -j auto -W --keep-going -w build_errors.txt -N
 
 if "%1" == "" goto help
 if "%1" == "clean" goto clean

doc/source/conf.py

@@ -85,6 +85,9 @@
     # type, unless multiple values are being returned"
 }
 
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
 # The suffix(es) of source filenames.
 source_suffix = ".rst"
 

examples/00-fluent/mixing_elbow.py

@@ -70,9 +70,8 @@
 ###############################################################################
 # Add local sizing:
 # In the Add Local Sizing task, you are prompted as to whether or not you would
-# like to add local sizing controls to the faceted geometry. For the purposes
-# of this example, you can keep the default setting. Execute to complete this
-# task
+# like to add local sizing controls to the faceted geometry. For the purposes of
+# this example, you can keep the default setting. Execute to complete this task
 # and proceed to the next task in the workflow.
 session.workflow.TaskObject["Add Local Sizing"].AddChildToTask()
 session.workflow.TaskObject["Add Local Sizing"].Execute()
@@ -94,8 +93,7 @@
 # relating to the nature of the imported geometry. Since the geometry defined
 # the fluid region. Select The geometry consists of only fluid regions with no
 # voids for Geometry Type. Execute Describe Geometry to complete this task and
-# proceed
-# to the next task in the workflow.
+# proceed to the next task in the workflow.
 session.workflow.TaskObject["Describe Geometry"].UpdateChildTasks(
     SetupTypeChanged=False
 )
@@ -350,10 +348,18 @@
 ###############################################################################
 # Examine the mass flux report for convergence: Select cold-inlet, hot-inlet,
 # and outlet from the Boundaries selection list.
+
 # session.tui.solver.report.fluxes.mass_flow(
-#    "no", "cold-inlet", "hot-inlet", "outlet", "()", "yes", "mass-flux1.flp"
+#     "no",
+#     "cold-inlet",
+#     "hot-inlet",
+#     "outlet",
+#     "()",
+#     "yes",
+#     "mass-flux1.flp",
 # )
 
+
 ###############################################################################
 # Save the data file (mixing_elbow1.dat.h5).
 # session.tui.solver.file.write_data('mixing_elbow1.dat.h5')
@@ -453,19 +459,20 @@
 )
 # session.tui.solver.display.objects.display("xy-outlet-temp")
 # session.tui.solver.plot.plot(
-#    "yes",
-#    "temp-1.xy",
-#    "no",
-#    "no",
-#    "no",
-#    "temperature",
-#    "yes",
-#    "1",
-#    "0",
-#    "0",
-#    "z=0_outlet",
-#    "()",
+#     "yes",
+#     "temp-1.xy",
+#     "no",
+#     "no",
+#     "no",
+#     "temperature",
+#     "yes",
+#     "1",
+#     "0",
+#     "0",
+#     "z=0_outlet",
+#     "()",
 # )
+#
 
 ###############################################################################
 # Mesh display using PyVista
@@ -500,7 +507,7 @@
 # contour_2 = graphics_session.Contours["contour_2"]
 # contour_2.field = "velocity-magnitude"
 # contour_2.surfaces_list = [
-#    "symmetry-xyplane"
+#     "symmetry-xyplane"
 # ]
 # contour_2.display()