build pdfs from md files

.gitingore

@@ -0,0 +1 @@
+*.err

README.md

@@ -1 +1,24 @@
 # handoverdocs
+
+
+To build pdfs of the docs you can use pandoc. On osx install:
+
+```
+brew install pandoc```
+```
+Now install tex
+```
+brew install basictex
+```
+Install the mermaid folter
+```
+npm i -g mermaid-filter
+```
+As an example, run:
+```
+pandoc  -F mermaid-filter conda_build.md -o conda_build.pdf -V papersize:a4 --highlight-style pygments
+```
+
+Once the dependencies are install you can run the build script build.sh
+
+Else you can view the docs in vscode.

build.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -ex
+
+
+pandoc  -F mermaid-filter conda_build.md -o conda_build.pdf -V papersize:a4 --highlight-style pygments
+
+pandoc  -F mermaid-filter conda_envs.md -o conda_envs.pdf -V papersize:a4 --highlight-style pygments
+
+pandoc  -F mermaid-filter windows_debug.md -o windows_debug.pdf -V papersize:a4 --highlight-style pygments
+
+pandoc  -F mermaid-filter packaging.md -o packaging.pdf -V papersize:a4 --highlight-style pygments
+
+pandoc  -F mermaid-filter general_docs.md -o general_docs.pdf -V papersize:a4 --highlight-style pygments

conda_build.md

@@ -1,4 +1,6 @@
-  # Conda build (nightly and release)
+# Conda build (nightly and release)
+==========================================
+
 ```mermaid
 graph TD
     A[Mantid dependencies] -->|Parse requirements| B(Conda recipes)   

conda_envs.md

@@ -0,0 +1,35 @@
+# From dependencies to conda environments
+From our initial list of mantid dependencies, we can extract our conda depenendices and source approairate versions from conda forge. These dependnecies are consumed in three ways: (1) By our local environment files used to build mantid (2) By the conda-build meta.yaml file used to speicify our build, host and runtime requirements of our mantid package. And lastly, when creating an installer we create a construct.yamlf file, which defines our python dependencies. 
+```mermaid
+graph TD
+    A[Mantid dependencies] -->|Parse requirements| B(Create conda environment files)   
+
+    B -->|mantid-developer.yaml| D[Local conda environment] 
+    B -->|meta.yaml| E[Conda build recipe]
+
+
+    D --> |used by| I[Local build]
+    D --> |used by| H[CI build]
+    I --> O[Local use]
+    I --> |install|P[local install]
+
+    E --> |creates| G[mantid-framework]
+    E --> |creates| J[mantid-qt]
+    J <--> |uses| G
+    J --> |used by| K
+    E --> |creates| K[mantid-workbench ]
+
+    G --> MM[conda packages]
+    J --> MM[conda packages]
+    K --> MM[conda packages]
+
+ 
+
+    LL[build scripts] --> E[conda-build]
+
+
+    P -->|CPack| BB[Standalone installer]
+    CC[conda constructor] --> BB
+    B -->|construct.yaml| CC
+  
+```

mermaid-images/de986b3a341c707c28e0d09faa7ed52851618c95.mmd

@@ -0,0 +1,17 @@
+graph TD
+    A[Mantid dependencies] -->|Parse requirements| B(Conda recipes)   
+
+    B --> F[mantid-framework, mantidqt, mantid-workbench] 
+
+    AA[Main branch] --> G
+    L --> H
+    BB[Release tag] -->  H[conda-feedstock]
+    L --> G[mantid recipes]
+
+    F -->L[meta.yaml & build scripts]
+
+    G --> |uploads to|I[mantid channel]
+    H --> |uploads to|J[conda-forge channel]
+
+    I <--> |once per day|G
+    J <--> |once per release|H