docs: fix links in code snippets#6734
Merged
benlesh merged 1 commit intoReactiveX:masterfrom Jan 4, 2022
Merged
Conversation
Member
Author
|
This is how changes from this PR look like: (Please notice the commit hash in the end of gif, it matches the one from this PR.) |
Closed
This was referenced Jan 11, 2022
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
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.

Description:
I'm once again sorry for the very large PR. This PR fixes issue where
autoLinkCodewasn't able to produce links in code snippets. For example, if there was a snippet like this (in any exported.tsor.mdfile):autoLinkCodewould generate links whereverfrom,Subjectandmulticastwere written becausefrom,Subjectandmulticastare valid documentation pages.The real reason why this
autoLinkCodefailed to do some processing was that it was actually excluded frompostProcessHtml.plugins. At first, it was added to thepostProcessHtml.pluginsarray, but later,pluginsarray was overwritten with another array (with aembedMarbleDiagramsPostProcessorplugin). Now, I fixed it to pushembedMarbleDiagramsPostProcessorto an existing array instead of creating a new one.autoLinkCodewas adjusted so that it follows the same code structure from Angular project.Also, one more thing that
embedMarbleDiagramsPostProcessorwas doing is that it was copying files fromdocs_app/src/assets/images/marble-diagrams/todocs_app/assets/for no particular reason. I couldn't ever find where these files have been used, because all images in the app have hadsrctag that includedassets/images/marble-diagrams/path. For that reason, I removed copying these files, I removed all copied files and I removed the dependency associated with that -mkdirp.With removal of
mkdirp, I noticed another package that was accidentally added that's never used -typedoc. The docs generation is done by Angular scripts.Since these old (and reintroduced)
postProcessHtml.pluginswere never used for more than 2 years, some docs are now having multiple issues. One of the issues is that there are multiple docs where there are multiple H1 HTML tags. For that reason, I disabled a processor that checks that because it fails to generate scripts. I will try to fix those issues if this PR lands to master.One last note: while I was creating PRs related to #6627, I forgot to remove old images (
audit.png,debounce.pngandthrottle.png), so I removed them here.Related issue (if exists):
None, only this comment.