JTL-Shop Core Documentation

https://gitlab.com/jtl-software/jtl-shop/core/-/tree/master/docs

Admin

This is the core documentation for JTL-Shop, an e-commerce solution. It likely details the...

Tokens:1,065

Snippets:17

Trust Score:10

Update:7 months ago

Show doc for...

Tokens:

Raw

### Configure API URL for Sphinx Documentation

Source: https://gitlab.com/jtl-software/jtl-shop/core/-/tree/master/docs/en_rst/_exts_ref_type=heads

This setting configures the base URL for API documentation links within Sphinx. It allows for dynamic generation of links to the Symfony API, using a placeholder for the specific API resource.

```python
api_url = 'http://api.symfony.com/master/%s'
```

--------------------------------

### Set Primary Domain to PHP in Sphinx

Source: https://gitlab.com/jtl-software/jtl-shop/core/-/tree/master/docs/en_rst/_exts_ref_type=heads

This configuration setting for Sphinx specifies that the primary domain for documentation should be PHP. This affects how cross-references and other domain-specific directives are interpreted.

```python
primary_domain = 'php'
```

--------------------------------

### Configure PHP Code Highlighting in Sphinx

Source: https://gitlab.com/jtl-software/jtl-shop/core/-/tree/master/docs/en_rst/_exts_ref_type=heads

This snippet shows how to configure Sphinx to enable highlighting for PHP code that is not enclosed within standard <?php ?> tags. It involves loading the PhpLexer from Pygments and assigning it to the 'php' and 'php-annotations' lexer types.

```python
# loading PhpLexer
from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer

# enable highlighting for PHP code not between ``<?php ... ?>`` by default
lexers['php'] = PhpLexer(startinline=True)
lexers['php-annotations'] = PhpLexer(startinline=True)
```

Tokens:

Raw