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.

Sign up for GitHub

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

Jump to bottom

Document available lexers #51307

Closed
acozine opened this issue Jan 24, 2019 · 4 comments · Fixed by #71458
Closed

Document available lexers #51307

acozine opened this issue Jan 24, 2019 · 4 comments · Fixed by #71458
Assignees
@Akasurde
Labels
affects_2.8 This issue/PR affects Ansible v2.8 docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
OLD Ansible Documentation

Comments

@acozine
Copy link
Contributor

acozine commented Jan 24, 2019

SUMMARY

The Ansible documentation supports a range of Pygments lexers for Sphinx to make our code examples look good. Examples include YAML, python, Jinja2, and more. Each lexer parses a particular type of text and adds color-coding and formatting to the HTML based on the rules of that text type.

Document which lexers we support, the correct syntax (for example, YAML+Jinja or ansible-output) for each one, and how to choose the best lexer for each code example or block of text.

Related to #50836.

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

docs.ansible.com

ANSIBLE VERSION

2.8

CONFIGURATION

N/A

OS / ENVIRONMENT

N/A
@ansibot
Copy link
Contributor

ansibot commented Jan 24, 2019

Files identified in the description:
None

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Jan 24, 2019
@acozine
Copy link
Contributor Author

acozine commented Jan 24, 2019 •
edited
Loading

This content belongs somewhere in the style guide. Probably in the section on rST.

@acozine acozine removed the needs_triage Needs a first human triage before being processed. label Jan 24, 2019
@ansibot
Copy link
Contributor

ansibot commented Apr 29, 2020

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@Akasurde Akasurde mentioned this issue Aug 26, 2020
Merged
Akasurde added a commit to Akasurde/ansible that referenced this issue Aug 26, 2020
@Akasurde
dev_guide: Add Pygments Lexer examples
262774f 
Fixes: ansible#51307

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
@Akasurde
Copy link
Member

resolved_by_pr #71458

@Akasurde Akasurde added this to To do in OLD Ansible Documentation via automation Aug 26, 2020
@Akasurde Akasurde moved this from To do to In progress in OLD Ansible Documentation Aug 26, 2020
@Akasurde Akasurde self-assigned this Aug 26, 2020
@ansibot ansibot added the has_pr This issue has an associated PR. label Aug 26, 2020
acozine added a commit that referenced this issue Sep 24, 2020
@Akasurde @acozine
dev_guide: Add Pygments Lexer examples (#71458)
4f990e7 
* dev_guide: Add Pygments Lexer examples

Fixes: #51307

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* adds ansible-output lexer, remmoves unsupported lexers

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
@acozine acozine moved this from In progress to Done in OLD Ansible Documentation Sep 24, 2020
heiderich pushed a commit to heiderich/ansible that referenced this issue Oct 4, 2020
@Akasurde @acozine @heiderich
dev_guide: Add Pygments Lexer examples (ansible#71458)
03c4ef1 
* dev_guide: Add Pygments Lexer examples

Fixes: ansible#51307

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* adds ansible-output lexer, remmoves unsupported lexers

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
@ansible ansible locked and limited conversation to collaborators Oct 22, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@Akasurde Akasurde

Labels
affects_2.8 This issue/PR affects Ansible v2.8 docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
No open projects
OLD Ansible Documentation
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

dev_guide: Add Pygments Lexer examples Akasurde/ansible
3 participants
@Akasurde @acozine @ansibot