Skip to content

Comments

docs: fix links broken in previous doc cleanup.#11115

Merged
ggreenway merged 1 commit intoenvoyproxy:masterfrom
ggreenway:doc-link-fixes
May 9, 2020
Merged

docs: fix links broken in previous doc cleanup.#11115
ggreenway merged 1 commit intoenvoyproxy:masterfrom
ggreenway:doc-link-fixes

Conversation

@ggreenway
Copy link
Member

Commit Message:
The links were broken in 8e8209f

Fixes: #11078

Signed-off-by: Greg Greenway ggreenway@apple.com

The links were broken in 8e8209f

Fixes: envoyproxy#11078

Signed-off-by: Greg Greenway <ggreenway@apple.com>
@@ -0,0 +1,6 @@
Deprecated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use this? https://github.com/sphinx-contrib/redirects WDYT? This could help with other similar moves in the future?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I briefly looked into it, but it wasn't available (or I failed to find it) in pip3, so I gave up.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

@ggreenway ggreenway May 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I played with this for an hour, and I think the redirects extension is incompatible with the version of sphinx we're using.

I get this error:

Traceback (most recent call last):
  File "envoy/build_docs/venv/lib/python3.7/site-packages/sphinx/cmd/build.py", line 283, in build_main
    args.tags, args.verbosity, args.jobs, args.keep_going)
  File "envoy/build_docs/venv/lib/python3.7/site-packages/sphinx/application.py", line 268, in __init__
    self._init_builder()
  File "envoy/build_docs/venv/lib/python3.7/site-packages/sphinx/application.py", line 329, in _init_builder
    self.events.emit('builder-inited')
  File "envoy/build_docs/venv/lib/python3.7/site-packages/sphinx/events.py", line 103, in emit
    results.append(callback(self.app, *args))
  File "envoy/build_docs/venv/src/sphinxcontrib-redirects/sphinxcontrib/redirects/__init__.py", line 30, in generate_redirects
    in_suffix = app.config.source_suffix[0]
KeyError: 0

I tried making source_suffix into a list in our config, but that didn't fix it. From https://www.sphinx-doc.org/en/master/usage/configuration.html, I think that this field became a hash at some point, so indexing [0] won't work with current versions of sphinx.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK np thanks a lot for trying.

Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@mattklein123 mattklein123 self-assigned this May 8, 2020
@ggreenway ggreenway merged commit 888e0e2 into envoyproxy:master May 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecated extension documentation link is broken

2 participants