Doc: Fix Build Namespace and Broken Links #3925
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
…s it. - Update pymdown snippets to allow inclusion outside of manual root. - Update pymdown snippets to fail on build if snippet can't be found.
…ource dir directly.
colinthomas-z80
pushed a commit
to colinthomas-z80/cctools
that referenced
this pull request
Oct 15, 2024
…3925) * - Modify doc build and test instructions to match how readthedocs does it. - Update pymdown snippets to allow inclusion outside of manual root. - Update pymdown snippets to fail on build if snippet can't be found. * Remove symlink to code-examples, make examples refer to examples in source dir directly. * Fix up broken internal references.
btovar
pushed a commit
that referenced
this pull request
Oct 21, 2024
* - Modify doc build and test instructions to match how readthedocs does it. - Update pymdown snippets to allow inclusion outside of manual root. - Update pymdown snippets to fail on build if snippet can't be found. * Remove symlink to code-examples, make examples refer to examples in source dir directly. * Fix up broken internal references.
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.
Proposed Changes
The online version of the docs had big blank spaces where the example code should be!
Merge Checklist
The following items must be completed before PRs can be merge.
Check these off to verify you have completed all steps.
make testRun local tests prior to pushing.make formatFormat source code to comply with lint policies. Note that some lint errors can only be resolved manually (e.g., Python)make lintRun lint on source code prior to pushing.