Begin restructuring of doc-building roles with OOMMF. We use the rst_to_html role to build documentation now, and all documentation lives in guest_resources, which should be shared with the virtual machine.

Author: mvousden

…mf_examples/templates/oommf_examples.rst guest_resources/oommf/oommf_examples.rstroles/oommf_examples/templates/oommf_examples.rst renamed to guest_resources/oommf/oommf_examples.rst roles/oommf_examples/templates/oommf_examples.rst renamed to guest_resources/oommf/oommf_examples.rst

@@ -1,3 +1,4 @@
 ---
 dependencies:
-  - { role: oommf }
+  - { role: oommf }
+  - { role: rst_to_html, BUILD_DIR: "{{ EXAMPLES_DOC_FOLDER }}", SOURCE_PATH: "{{ EXAMPLES_RST_FILE }}", BUILD_NAME: "{{ EXAMPLES_OUTPUT_NAME }}" }

roles/oommf_examples/meta/main.yml

@@ -2,5 +2,9 @@
 # This Ansible role prepares OOMMF examples and places some documentation on
 # the Desktop.
 
-- include: oommf_examples.yml
-- include: build_documentation.yml
+# This task is not very robust, but I can't think of a better way of doing
+# this.
+- name: Copy oommf examples to a more accessible location.
+  command: cp -r /opt/oommf/oommf-1.2a5bis/app/oxs/examples {{ OOMMF_EXAMPLES_FOLDER }}
+    creates={{ OOMMF_EXAMPLES_FOLDER }}
+  sudo: yes

roles/oommf_examples/tasks/build_documentation.yml

@@ -2,8 +2,9 @@
 EXAMPLES_FOLDER: /etc/skel
 OOMMF_EXAMPLES_FOLDER: "{{ EXAMPLES_FOLDER }}/oommf-oxs-examples"
 
-# Name of the RST template to generate HTML examples from.
-EXAMPLES_RST_FILE: oommf_examples.rst
+# Path of the RST template to generate HTML examples from.
+EXAMPLES_RST_FILE: /vagrant/extra_resources/oommf/oommf_examples.rst
+EXAMPLES_OUTPUT_NAME: OOMMF_examples.html
 
 # Location to place the HTML documentation.
 EXAMPLES_DOC_FOLDER: "{{ EXAMPLES_FOLDER }}/Desktop"