Ensure clean compilation of documents on each run
Ensure that every build of the documentation for a project is clean and repeatable.
Description
Modified the psake tasks for the project and the template both to compile documentation into a separate folder. Added a task for cleaning that folder between runs. Updated the gitignore file and template to reflect this new layout.
Related Issue
This resolves #5 (closed).
Motivation and Context
Previously, rerunning builds of documentation lead to errors and issues. Now, the clean task and the new layout for compiling the docs ensures we don't have to write complicated logic to handle those things.
How Has This Been Tested?
Locally, manually.
Types of changes
-
Bug fix (non-breaking change which fixes an issue) -
New feature (non-breaking change which adds functionality) -
Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
-
My code follows the code style of this project. -
My change requires a change to the documentation. -
I have updated the documentation accordingly. -
I have read the CONTRIBUTING document. -
I have added tests to cover my changes. -
All new and existing tests passed.