-
Notifications
You must be signed in to change notification settings - Fork 139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add option to let Documenter
clear target folder before rendering documentation
#644
Comments
I would like to contribute this functionality. Option 1: Option 2: @ciberkleid, @odrotbohm what do you think about my suggestions? Do you have a different API in mind for this feature? |
Cora and me had a brief hacking session recently and we went down introducing an |
Documenter
clear target folder before rendering documentation
Documenter now remembers whether it has cleared the output directory so that multiple attempts to clear on one Documenter instance will not wipe the content previously generated on the same instance. All methods ultimately creating files trigger the one-time target folder wipe now. Moved file system operations into the OutputFolder abstraction. A couple of parameter renames for consistency.
Request for a Documenter option that clears the target output directory before writing documentaiton.
Reasoning:
If a module is renamed or deleted, any existing documentation will remain in the target output directory until the user runs a mvn clean. This can be misleading as the documentation will include modules that don't exist.
The text was updated successfully, but these errors were encountered: