Skip to content

Documentation

Documentation #424

Workflow file for this run

name: Documentation
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout EnergyPlus
uses: actions/checkout@v4
- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Set up LaTeX
run: sudo apt update && sudo apt install -y texlive texlive-xetex texlive-science poppler-utils
- name: Create Build Environment
run: cmake -E make_directory ${{runner.workspace}}/EnergyPlus/doc/build
- name: Configure CMake
working-directory: ${{runner.workspace}}/EnergyPlus/doc/build
run: cmake -DTEX_INTERACTION=batchmode -DDOCS_TESTING=ON ..
- name: Add problem matcher
run: echo "::add-matcher::.github/workflows/doc-problem-match.json"
- name: Build Docs
working-directory: ${{runner.workspace}}/EnergyPlus/doc/build
run: cmake --build . -j 4
- name: Upload Acknowledgments
uses: actions/upload-artifact@v4
with:
name: Acknowledgments
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/Acknowledgments.pdf
- name: Upload AuxiliaryPrograms
uses: actions/upload-artifact@v4
with:
name: AuxiliaryPrograms
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/AuxiliaryPrograms.pdf
- name: Upload EMSApplicationGuide
uses: actions/upload-artifact@v4
with:
name: EMSApplicationGuide
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/EMSApplicationGuide.pdf
- name: Upload EnergyPlusEssentials
uses: actions/upload-artifact@v4
with:
name: EnergyPlusEssentials
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/EnergyPlusEssentials.pdf
- name: Upload EngineeringReference
uses: actions/upload-artifact@v4
with:
name: EngineeringReference
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/EngineeringReference.pdf
- name: Upload ExternalInterfacesApplicationGuide
uses: actions/upload-artifact@v4
with:
name: ExternalInterfacesApplicationGuide
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/ExternalInterfacesApplicationGuide.pdf
- name: Upload GettingStarted
uses: actions/upload-artifact@v4
with:
name: GettingStarted
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/GettingStarted.pdf
- name: Upload InputOutputReference
uses: actions/upload-artifact@v4
with:
name: InputOutputReference
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/InputOutputReference.pdf
- name: Upload InterfaceDeveloper
uses: actions/upload-artifact@v4
with:
name: InterfaceDeveloper
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/InterfaceDeveloper.pdf
- name: Upload ModuleDeveloper
uses: actions/upload-artifact@v4
with:
name: ModuleDeveloper
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/ModuleDeveloper.pdf
- name: Upload OutputDetailsAndExamples
uses: actions/upload-artifact@v4
with:
name: OutputDetailsAndExamples
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/OutputDetailsAndExamples.pdf
- name: Upload PlantApplicationGuide
uses: actions/upload-artifact@v4
with:
name: PlantApplicationGuide
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/PlantApplicationGuide.pdf
- name: Upload UsingEnergyPlusForCompliance
uses: actions/upload-artifact@v4
with:
name: UsingEnergyPlusForCompliance
path: ${{runner.workspace}}/EnergyPlus/doc/build/pdf/UsingEnergyPlusForCompliance.pdf
# - name: Test
# working-directory: ${{runner.workspace}}/build
# shell: bash
# # Execute tests defined by the CMake configuration.
# # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
# # run: ctest -C $BUILD_TYPE
# run: ls