trying some things for the website

Exawind · Oct 22, 2024 · cf9835b · cf9835b
1 parent 13f36bf
commit cf9835b
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 6 deletions.
diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
@@ -24,7 +24,7 @@ jobs:
         run: |
           export DEBIAN_FRONTEND=noninteractive
           python3 -m pip install --upgrade pip
-          pip3 install sphinx sphinx_rtd_theme sphinx_toolbox sphinx_copybutton
+          pip3 install sphinx sphinx_rtd_theme sphinx_toolbox sphinx_copybutton m2r
       - name: Build
         run: |
           echo "::add-matcher::.github/problem-matchers/sphinx.json"

diff --git a/.website_src/conf.py b/.website_src/conf.py
@@ -29,7 +29,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [ 'sphinx.ext.mathjax', 'sphinx_toolbox.collapse', 'sphinx_copybutton']
+extensions = [ 'sphinx.ext.mathjax', 'sphinx_toolbox.collapse', 'sphinx_copybutton', 'sphinx_mdinclude' ]
 
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/.website_src/exawind/benchmarks.rst b/.website_src/exawind/benchmarks.rst
@@ -1,8 +1,7 @@
 Benchmark problems using hybrid overset solver (ExaWind)
 ========================================================
 
-NREL Phase VI turbine
----------------------
+.. mdinclude:: ../../exawind/NREL_Phase_VI_Turbine/README.md
 
 With RANS
 ^^^^^^^^^

diff --git a/exawind/NREL_Phase_VI_Turbine/README.md b/exawind/NREL_Phase_VI_Turbine/README.md
@@ -1,6 +1,6 @@
+<!-- This file is automatically compiled into the website. Begin headings with ##, not #, to avoid breaking the website heading hierarchy. -->
 
-
-# NREL Phase VI Rotor
+## NREL Phase VI Turbine
 
 ExaWind simulations are performed for NREL’s Unsteady Aerodynamics Experiment Phase VI rotor. The experimental conditions are summarized below: