Fix Sphinx cross-reference errors, refactor example scripts #145
Conversation
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
signal_inj examples modified examples code cleaning
…into update-examples
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.
This pull request contains a fix for Sphinx "more than one target found for cross-reference" errors, as modules from motulator.common are no longer imported as part of drive packages. Drive example scripts have been modified to import these packages directly from motulator.common, as was already done in grid examples.
The examples folder has been split into examples/drive and examples/grid, to facilitate having the examples separate in the documentation. Note: while building the documentation, Sphinx will warn about unknown documents in references to the example scripts, as the new paths for example galleries have not yet been updated in the document source files. This will be fixed in the next pull request.