Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Nrichers/sc 6760/store python docs as zip file and extract#461

Merged
nrichers merged 7 commits intomainvalidmind/documentation:mainfrom
nrichers/sc-6760/store-python-docs-as-zip-file-and-extractvalidmind/documentation:nrichers/sc-6760/store-python-docs-as-zip-file-and-extractCopy head branch name to clipboard
Oct 10, 2024
Merged

Nrichers/sc 6760/store python docs as zip file and extract#461
nrichers merged 7 commits intomainvalidmind/documentation:mainfrom
nrichers/sc-6760/store-python-docs-as-zip-file-and-extractvalidmind/documentation:nrichers/sc-6760/store-python-docs-as-zip-file-and-extractCopy head branch name to clipboard

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Oct 2, 2024

Internal Notes for Reviewers

This PR modifies the make python-docs action to replace our folder of HMTL Python docs with a single .zip file that gets unzipped on the fly. This change should stop git status from cluttering your view if you run quarto preview.

Easiest way to test, requires that you ran make get-source at some point:

  • Delete site/python-docs.zip and the site/_site/validmind/ folder.
  • Run quarto render and check that the python-docs.zip file reappears in the site output folder and that the ValidMind Developer Framework reference still works when you open the docs site locally.

External Release Notes

@nrichers nrichers added infrastructure Docs infra changes internal Not to be externalized in the release notes labels Oct 2, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

A PR preview is available: Preview URL

@nrichers nrichers requested a review from validbeck October 2, 2024 02:43
Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I lost this in my inbox for a while! It looks good, thank you for setting it up!

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@nrichers
Copy link
Collaborator Author

There was an issue with the paths inside the .zip file which is why the preview didn't work. Fixed in 90a5b0d — now the preview works as expected and the Python docs also work locally.

@nrichers nrichers merged commit 1613ac6 into main Oct 10, 2024
@nrichers nrichers deleted the nrichers/sc-6760/store-python-docs-as-zip-file-and-extract branch October 10, 2024 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

infrastructure Docs infra changes internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.