Skip to content
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 gen-page script to generate a single page #1357

Open
Eric-Arellano opened this issue May 13, 2024 · 0 comments
Open

Add gen-page script to generate a single page #1357

Eric-Arellano opened this issue May 13, 2024 · 0 comments

Comments

@Eric-Arellano
Copy link
Collaborator

#1336 made it much easier to test out WIP docs. But it still takes a while to regenerate the entire docs build for the package, when often you're only changing a single page.

This issue is to add a new script that allows you to generate a single page using sphinxHtmlToMarkdown.ts, rather than the full conversionPipeline.ts. It would not do the last steps of:

// Warning: the sequence of operations often matters.
await writeMarkdownResults(pkg, docsBaseFolder, results);
await copyImages(pkg, htmlPath, publicBaseFolder, results);
await maybeObjectsInv?.write(pkg.outputDir(publicBaseFolder));
await maybeUpdateReleaseNotesFolder(pkg, markdownPath);
await writeTocFile(pkg, markdownPath, results);
await writeVersionFile(pkg, markdownPath);

It should probably still post-process results though:

const results = await postProcessResults(
pkg,
maybeObjectsInv,
initialResults,

TBD what the CLI API looks should be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant