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

Only references pages that are new or have changed since the last build #13

Open
jdillard opened this issue Jun 18, 2018 · 1 comment
Open
Labels

Comments

@jdillard
Copy link
Owner

jdillard commented Jun 18, 2018

Issue

The builder currently doesn't access to the saved environment, so it can only see pages that are new or have changed since the last build, possibly leading to an incomplete sitemap.

Work around

To get around this you can manually clean the build directory or use the -E flag to not use the saved environment and rebuild completely as part of your deployment process.

Possible fix

The saved environment is pickled after the parsing stage, so accessing it may make it possible to always produce a full sitemap. Using doctree-resolved instead might be a possibility.

Temp fix

Test if sphinx is running a partial build and output a warning.

@jdillard jdillard added the bug label Jun 18, 2018
@dbitouze
Copy link

dbitouze commented Nov 22, 2023

We are suffering from this bug.

Let me explain the context: We use Sphinx for a LaTeX FAQ that contains more than 1200 pages. We've worked hard to ensure that only modified pages are automatically (thanks to a GitLab CI/CD process) (re)generated each time a contributor modifies a source file (Markdown). In fact, recompiling all the pages each time was too time-consuming (around 15 minutes) and unnecessarily energy-consuming.

So, when a contributor modifies a single source file, only the corresponding .html file is (re)generated) and we are very happy with this, so the workaround you suggest cannot be an option for us); but, now, the problem is, the sitemap.xml contains (almost?) only the path to the corresponding .html file.

We'd be delighted if you could provide with a fix! 😃

@jdillard jdillard pinned this issue Dec 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants