use tabs

FriendsOfSymfony · Nov 15, 2021 · f0170aa · f0170aa
1 parent e666647
commit f0170aa
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -2,3 +2,7 @@ version: 2
 
 sphinx:
   configuration: Resources/doc/conf.py
+
+python:
+  install:
+    - requirements: Resources/doc/requirements.txt
diff --git a/Resources/doc/annotations-reference.rst b/Resources/doc/annotations-reference.rst
@@ -94,9 +94,11 @@ All of them have the same options as ``@Route``.
 
 Example:
 
-.. configuration-block::
+.. tabs::
 
-    .. code-block:: php-annotations
+   .. tab:: Annotations
+
+    .. code-block:: php
 
         // src/Controller/BlogController.php
         namespace App\Controller;
@@ -114,8 +116,9 @@ Example:
                 // ...
             }
         }
+   .. tab:: Attributes
 
-    .. code-block:: php-attributes
+    .. code-block:: php
 
         // src/Controller/BlogController.php
         namespace App\Controller;

diff --git a/Resources/doc/conf.py b/Resources/doc/conf.py
@@ -1,9 +1,18 @@
 # -*- coding: utf-8 -*-
 
 import sys, os
+from sphinx.highlighting import lexers
+from pygments.lexers.web import PhpLexer
 
 project = 'FriendsOfSymfony / FOSRestBundle'
 author = 'FriendsOfSymfony community'
 
+extensions = [
+    'sphinx_tabs.tabs'
+]
+
 # This will be used when using the shorthand notation
 highlight_language = 'php'
+
+# enable highlighting for PHP code not between <?php ... ?> by default
+lexers['php'] = PhpLexer(startinline=True)
diff --git a/Resources/doc/requirements.txt b/Resources/doc/requirements.txt
@@ -0,0 +1,2 @@
+sphinx_rtd_theme
+sphinx-tabs