-
Notifications
You must be signed in to change notification settings - Fork 69
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
Auto update sphinx theme css files #291
Open
unidevel
wants to merge
1
commit into
prestodb:source
Choose a base branch
from
unidevel:auto_update_theme_files
base: source
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
(node website/updateSiteConfig.js && git add website/siteConfig.js) || true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
const fs = require('fs'); | ||
const path = require('path'); | ||
|
||
async function updateSphinxThemeFiles() { | ||
const siteConfigPath = path.join(__dirname, './siteConfig.js'); | ||
const staticDocsPath = path.join(__dirname, 'static/docs'); | ||
|
||
let content = fs.readFileSync(siteConfigPath, 'utf8'); | ||
let lines = content.split('\n'); | ||
|
||
const pattern = /\Wstatic\/sphinx_immaterial_theme\.[a-f0-9]+\.min\.css\W/; | ||
const insertLineIndex = lines.findIndex(line => pattern.test(line)); | ||
|
||
if (insertLineIndex === -1) { | ||
console.error('Could not find sphinx theme file references in siteConfig.js'); | ||
process.exit(1); | ||
} | ||
|
||
matchSet = new Set(); | ||
lines = lines.filter(line => { | ||
if ( !pattern.test(line) ){ | ||
return true; | ||
} else { | ||
matchSet.add(line.trim()); | ||
return false; | ||
} | ||
}); | ||
|
||
const versionFolders = fs.readdirSync(staticDocsPath) | ||
.filter(folder => /^\d+\.\d+(\.\d+)?$/.test(folder)); | ||
|
||
if (versionFolders.length === 0) { | ||
console.error('No version folders found'); | ||
process.exit(1); | ||
} | ||
|
||
const allCssFiles = []; | ||
const fileSet = new Set(); | ||
for (const version of versionFolders) { | ||
const staticPath = path.join(staticDocsPath, version, '_static'); | ||
if (fs.existsSync(staticPath)) { | ||
const files = fs.readdirSync(staticPath) | ||
.sort() | ||
.filter(file => file.startsWith('sphinx_immaterial_theme.') && file.endsWith('.min.css')) | ||
.filter(file => { | ||
if ( fileSet.has(file) ) return false; | ||
fileSet.add(file); | ||
return true; | ||
}) | ||
.map(file => ` "static/${file}",`); | ||
allCssFiles.push(...files); | ||
} | ||
} | ||
|
||
if (matchSet.size === allCssFiles.length && | ||
allCssFiles.every(file => matchSet.has(file.trim()))) { | ||
process.exit(1); | ||
} | ||
|
||
console.info('Found CSS files:', allCssFiles); | ||
lines.splice(insertLineIndex, 0, ...allCssFiles); | ||
|
||
fs.writeFileSync(siteConfigPath, lines.join('\n')); | ||
console.log('Successfully updated sphinx theme file references'); | ||
process.exit(0); | ||
} | ||
|
||
updateSphinxThemeFiles().catch(console.error); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems we now have two ways of fixing the CSS - one with the nodejs script you added, and another being this way using
sed
. I would prefer to unify itThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ZacBlanco This PR includes 2 different fixes:
fix-css
in package.json)And one enhancement:
The goal of this PR is to automate the manual steps involved in releasing documentation, enabling the integration with GitHub Actions in future, and simplifying local testing with minimal manual effort.