Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

get rid of Sphinx 2.1.2 errors #59001

Merged
merged 1 commit into from
Jul 12, 2019
Merged

Conversation

acozine
Copy link
Contributor

@acozine acozine commented Jul 11, 2019

SUMMARY

Fixes #57709

Currently we pin the docs build to Sphinx 1.x. This PR makes all the changes necessary to run a clean make webdocs using Sphinx 2.1.2 on Python 3.7.3.

Takes the same approach to fixing the PowerShell lexer concerns as https://github.com/ansible/ansible/pull/57508/files#diff-1653c8c6462362632397ce0e9c948610R405.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs.ansible.com

@acozine acozine added docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. labels Jul 11, 2019
@ansibot
Copy link
Contributor

ansibot commented Jul 11, 2019

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 core_review In order to be merged, this PR must follow the core review workflow. python3 support:core This issue/PR relates to code supported by the Ansible Engineering Team. windows Windows community labels Jul 11, 2019
Copy link
Contributor

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

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

Most of these code blocks currently look pretty ugly anyway, due to all the lexing error marks, see for example https://docs.ansible.com/ansible/devel/user_guide/windows_setup#delete-winrm-listener So lexing them with YAML+Jinja (which this PR probably does, since that's the default lexer IIRC) can't make it look worse :) For the long term, it might be better to fix the PowerShell lexer so that it accepts colons.

@samccann samccann merged commit 0dd3fb8 into ansible:devel Jul 12, 2019
@ansible ansible locked and limited conversation to collaborators Aug 9, 2019
@acozine acozine deleted the upgrade_sphinx branch October 14, 2019 19:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.9 This issue/PR affects Ansible v2.9 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. python3 support:core This issue/PR relates to code supported by the Ansible Engineering Team. windows Windows community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Upgrade docs build to Sphinx 2.x
6 participants