[doc] fix broken converter references after dftkit outsourcing (issue…#289
Open
the-hampel wants to merge 1 commit intounstablefrom
Open
[doc] fix broken converter references after dftkit outsourcing (issue…#289the-hampel wants to merge 1 commit intounstablefrom
the-hampel wants to merge 1 commit intounstablefrom
Conversation
…287) After PR #286 moved all converters to triqs_dftkit, the Sphinx build failed because autosummary tried to recursively import the now-missing triqs_dft_tools.converters.* submodules. - Remove `converters` from the recursive autosummary in documentation.rst - Add new converters_reference.rst page linking to dftkit docs with a backward-compatible import table - Add dftkit to intersphinx_mapping so :py:mod:/:py:class: refs resolve - Exclude stale _python_api/triqs_dft_tools.converters* files via exclude_patterns to prevent leftover generated files from re-triggering the import errors on incremental builds - Update :py:mod: cross-references in guide pages to point to the correct triqs_dftkit.* module paths - Fix all converter import statements in guide/tutorial .rst files and .py scripts: replace `from triqs_dft_tools.converters.xxx import *` (submodule no longer exists) with `from triqs_dft_tools.converters import XxxConverter` Closes #287
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
After PR #286 moved all converters to triqs_dftkit, the Sphinx build failed because autosummary tried to recursively import the now-missing triqs_dft_tools.converters.* submodules.
convertersfrom the recursive autosummary in documentation.rstfrom triqs_dft_tools.converters.xxx import *(submodule no longer exists) withfrom triqs_dft_tools.converters import XxxConverterCloses #287