docs: use sphinx githubpages extension #2418
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
Signed-off-by: Rafal Augustyniak <raugustyniak@lyft.com>
Augustyniak
added a commit
that referenced
this pull request
Jul 15, 2022
This reverts commit 529cbe5. Signed-off-by: Rafal Augustyniak <raugustyniak@lyft.com>
Augustyniak
added a commit
that referenced
this pull request
Jul 18, 2022
Description: Revert #2418 as the change did not fix the issues with images not appearing in documentation. envoy-mobile/envoy-mobile.github.io#24 fixed the issues instead. Risk Level: None. Testing: N/A Docs Changes: N/A Release Notes: N/A Signed-off-by: Rafal Augustyniak <raugustyniak@lyft.com>
jpsim
added a commit
that referenced
this pull request
Jul 18, 2022
* main: tools: fix source mapping (#2429) Update Envoy (#2427) tools: add arm64 debug run configuration (#2424) Revert "docs: use sphinx githubpages extension (#2418)" (#2425) Remove Tulsi configuration & docs (#2421) Fix isCleartextTrafficPermitted (#2420) Squelch two JNI build warnings (#2426) dns: allow using the `getaddrinfo`-based system DNS resolver (#2419) docs: use sphinx githubpages extension (#2418) Update Envoy (#2417) Remove rules_cc uses Bump Lyft Support Rotation (#2414) iOS: fix retain cycles in `EnvoyNetworkMonitor` (#2415) Update Envoy (#2413) engine: remove outdated comment about `registerFactories()` (#2412) api: make RequestTrailersBuilder and ResponseHeadersBuilder constructors public (#2410) Signed-off-by: JP Simard <jp@jpsim.com>
jpsim
pushed a commit
to envoyproxy/envoy
that referenced
this pull request
Nov 29, 2022
Description: Revert envoyproxy/envoy-mobile#2418 as the change did not fix the issues with images not appearing in documentation. envoy-mobile/envoy-mobile.github.io#24 fixed the issues instead. Risk Level: None. Testing: N/A Docs Changes: N/A Release Notes: N/A Signed-off-by: Rafal Augustyniak <raugustyniak@lyft.com> Signed-off-by: JP Simard <jp@jpsim.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.
Description: This change is an attempt to fix images in the generated documentation. As it is now they do not work - example. The issues seems to be caused by the fact that Sphinx puts all of the images in
_imagesdirectory and Github Pages, backed byjekyll, ignores all directories whose names start with_. The idea is to usesphinx.ext.githubpagesextension that puts.nojekyllfile in the root of the generated sphinx artifacts which is supposed to fix the issue as reported in https://stackoverflow.com/a/64544659. Not a great way to test this e2e locally so may need to revert the change if it turns out that the issue persists.Risk Level: Low, documentation changes
Testing: Generated sphinx's artifacts locally with and without the change. Confirmed that with the change I can see
.nojekyllfile being added togenerated/docsdirectory.Docs Changes:
Release Notes:
Signed-off-by: Rafal Augustyniak raugustyniak@lyft.com