Make it easier for contributors to preview docs site locally #162
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Internal Notes for Reviewers
This PR makes it easier for contributors to preview our docs site locally, without having to fetch content from other repos first.
Context
@robinzimmermann encountered an issue where the Python documentation that gets copied into our docs site in a post-render step was unavailable locally. This occurred because, as a new contributor, he hadn't run the
make get-source
command to fetch content from the developer-framework repository yet. Consequently, he was unable to preview his changes usingquarto preview
.Typically, updating the Python documentation is a task for writers preparing to publish the latest version of our docs site, making it unnecessary for contributors like Robin to deal with. To simplify the process for doc changes, this PR introduces a conditional check to check for the presence of the Python documentation in
site/_source/developer-framework/docs/_build
. If absent, it bypasses the copying of the Python docs in the post-render step and enables the docs site preview to work locally as expected.External Release Notes
We made it easier for contributors to preview and render the docs site locally, without having to fetch content from other repos first.