Merge pull request #1000 from sys-bio/actually-build-docs

Found out how the docs are actually made, and did that.
sys-bio · May 12, 2022 · acd7ab1 · acd7ab1
2 parents 93d3007 + 5b7f149
commit acd7ab1
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -778,6 +778,7 @@ stages:
           PythonLibDir: '$(PythonRoot)/lib'
           PythonExecutable: '$(PythonRoot)/bin/python'
           PipExecutable: '$(PythonRoot)/bin/pip'
+          SphinxExecutable: '$(PythonRoot)/bin/sphinx-build'
           PythonName: 'py39'
           PythonVersion: '3.9'
           LLVM_DOWNLOAD_LINK: 'https://github.com/sys-bio/llvm-13.x/releases/download/llvmorg-13.0.0/llvm13-ubuntu-gcc10-rel.tar.gz'
@@ -839,13 +840,15 @@ stages:
               echo "g++ $(g++ --version)"
               sudo add-apt-repository ppa:ubuntu-toolchain-r/test
               sudo apt-get update
-              sudo apt-get install -y gcc-10 g++-10 doxygen python3-sphinx
+              sudo apt-get install -y gcc-10 g++-10 doxygen
               sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-10 1
             displayName: Install g++10
           - script: |
               eval "$(conda shell.bash hook)"
               conda create -y --name $(PythonName) python=$(PythonVersion)
               $(PipExecutable) install requests
+            displayName: "Install Python via conda"
+          - script: |
               $(PythonExecutable) ./.azurepipelines/getLLVM.py $(LLVM_DOWNLOAD_LINK) $(LLVM_INSTALL_PREFIX)
               echo "give execute permissions to llvm-config using chmod 777"
               chmod 777 $(LLVM_INSTALL_PREFIX)/bin/llvm-config
@@ -914,9 +917,28 @@ stages:
               rm -r $(Build.ArtifactStagingDirectory)/*
             displayName: Clear staging area
             condition: eq(variables.BuildType, 'Release')
+          - script: |
+              echo "cd to docs dir"
+              cd $(SOURCE_DIR)/docs/
+              echo "pip install dependencies"
+              $(PipExecutable) install -r requirements.txt
+              export SPHINXBUILD=$(SphinxExecutable)
+              echo "make html"
+              make html
+              echo "list build/html"
+              ls build/html
+              echo "move docs to installation"
+              cd
+              pwd
+              mkdir $(INSTALL_DIR)/docs
+              mv $(SOURCE_DIR)/docs/build/html '$(INSTALL_DIR)/docs/docs-build'
+              mv $(SOURCE_DIR)/docs/doxygen-output '$(INSTALL_DIR)/docs/doxygen-output'
+              ls '$(INSTALL_DIR)/docs'
+            displayName: Make Docs
+            condition: eq(variables.BuildType, 'Release')
           - task: CopyFiles@2
             inputs:
-              contents: '$(SOURCE_DIR)/docs/docs-build/**'
+              contents: '$(INSTALL_DIR)/docs/**'
               targetFolder: $(Build.ArtifactStagingDirectory)
             displayName: Copy docs to Staging Area
             condition: eq(variables.BuildType, 'Release')

diff --git a/docs/source/developers_docs/building_documentation.rst b/docs/source/developers_docs/building_documentation.rst
@@ -30,7 +30,7 @@ For example:
 
     cmake -DCMAKE_INSTALL_PREFIX=../install-mac-rel \
         -DRR_DEPENDENCIES_INSTALL_PREFIX=/Users/ciaranwelsh/Documents/libroadrunner-deps/install-clang13-rel \
-        -DLLVM_INSTALL_PREFIX=/Users/ciaranwelsh/Documents/llvm-6.x/llvm-6.x-clang11.0.3-x64-release \
+        -DLLVM_INSTALL_PREFIX=/Users/ciaranwelsh/Documents/llvm-13.x/llvm-13.x-clang11.0.3-x64-release \
         -DBUILD_TESTS=ON \
         -DPython_ROOT_DIR=/Users/ciaranwelsh/miniconda3/envs/py39 \
         -DBUILD_PYTHON=ON \