Check if the GraphQL lexer works in all documentation repos
Open
Nobody has claimed this yet.
internal
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
What needs to be done
Reviewer: @Onvember
Definition of done
- add graphql-lexer dependency in the docker image https://github.com/tarantool/doc-builder/pull/6
- setup graphql lexer in the main project's conf.py
- setup in the Enterprise docs
- setup in the TDG docs
- setup in the standalone Cartridge docs
from pygments_graphql import GraphqlLexer
# Sphinx 1.7.2
lexers['graphql'] = GraphqlLexer()
# Sphinx 3.x
lexers['graphql'] = GraphqlLexer
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating conf.py in the main project and in the Enterprise, TDG, and standalone Cartridge documentation repositories. Compare their Sphinx lexer configuration with the provided Sphinx version examples, then verify that GraphQL code blocks render correctly in each documentation build.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- graphql, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100