Skip to content

Make it easier for contributors to preview docs site locally #162

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

Merged
merged 1 commit into from
Mar 16, 2024

Conversation

nrichers
Copy link
Collaborator

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 using quarto 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.

@nrichers nrichers added the enhancement New feature or request label Mar 16, 2024
@nrichers nrichers changed the title Makes it easier for contributors to preview docs site locally Make it easier for contributors to preview docs site locally Mar 16, 2024
@nrichers nrichers merged commit d672158 into main Mar 16, 2024
@nrichers nrichers deleted the skip-python-docs branch March 16, 2024 00:55
@nrichers nrichers restored the skip-python-docs branch March 16, 2024 00:56
@nrichers nrichers deleted the skip-python-docs branch March 16, 2024 01:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants