Adjust 'make docs' to do an incremental build #16835
Merged
Conversation
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 was referenced Dec 9, 2020
mppf
added a commit
to chapel-lang/sphinxcontrib-chapeldomain
that referenced
this pull request
Dec 9, 2020
Fix problem: dictionary changed size during iteration The issue comes up when using sphinx to do an incremental docs build (see chapel-lang/chapel#16835 ) I encountered an error along these lines: ``` Exception occurred: File "CHPL_HOME/third-party/chpl-venv/install/chpldeps/sphinxcontrib/chapeldomain/__init__.py", line 810, in clear_doc for fullname, (fn, x) in self.data['objects'].items(): RuntimeError: dictionary changed size during iteration The full traceback has been saved in /var/folders/b6/1lwlz22n5d53878_x52vp3kr0007pg/T/sphinx-err-xabz0j9_.log, if you want to report the issue to the developers. Please also report this if it was a user error, so that a better error message can be provided next time. A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks! ``` To fix, this PR adjusts `clear_doc` to save the keys to remove in a list and then remove them. Reviewed by @lydia-duncan - thanks!
lydia-duncan
approved these changes
Dec 14, 2020
2 tasks
e-kayrakli
added a commit
that referenced
this pull request
Dec 14, 2020
Upgrade sphinxcontrib version, fix some spec highligting issues This PR: - Upgrades sphinxcontrib-chapeldomain from 0.0.17 to 0.0.19, which includes: - A more complete pygments highlighter: chapel-lang/sphinxcontrib-chapeldomain#41 - A patch for enabling incremental builds: chapel-lang/sphinxcontrib-chapeldomain#45 With this change we can now merge #16835 - Fix some of the codeblocks in the specs to have the correct highlighting. Previously, these didn't specify a specific highlighting language, because our highlighters weren't able to parse the snippets. The new highlighter is able to parse them, so this PR just makes them `.. code-block:: chapel` See #14623 [Reviewed by @mppf and @lydia-duncan] Test: - [x] `third-party/chpl-venv` builds - [x] `make docs` generates correct highlighting for the changed cases
--- Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
--- Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
Now 'make docs' should correctly handle the case where a file is deleted. --- Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
--- Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
mppf
force-pushed
the
make-docs-incremental
branch
from
00b1e70
to
71f67d3
Compare
ben-albrecht
approved these changes
Dec 14, 2020
There was a problem hiding this comment.
Looks good overall.
I got a docs build error when updating from a really old branch due to man page existing, but I was unable to reproduce it (and it doesn't really make sense to me).
I also spot-checked various edge cases to make sure things were always getting rebuilt if changed.
I have a minor doc request inline. Thanks!
--- Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
--- Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves #16826
Note, #16862 /
chapel-lang/sphinxcontrib-chapeldomain#45 is
required for this change to function properly - but this branch has those
changes.
This PR adjusts
make docsto do an incremental sphinx build. For now,the
chpldoccommand always runs, but the scripts only update the sourcefiles for
sphinx-buildif they are different.This brings a
make docsafter a minor change to about 10 seconds.Details:
util/config/update-if-differentto include a mode argument(
--updateor--copy) and adjusts the existing calls to it to usethe
--updateargument.--copymode toutil/config/update-if-differentthat willcopy all updated source files (recursively) and delete things in the
dst directory not present in src.
in a subdirectory of build/doc/ and then using
update-if-different --copyfrom here (so that removed files can be correctly handled)make docsto avoid deleting "build" directory(since we can use it again, incrementally)
make SHELL='sh -x' docsto see the commands again.Reviewed by @ben-albrecht and @lydia-duncan - thanks!