Skip to content

Commit 10bb9d3

Browse files
committed
chore: adding config file
1 parent 2fbf833 commit 10bb9d3

5 files changed

Lines changed: 232 additions & 169 deletions

File tree

docs/conf.py

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
from sphinx.highlighting import lexers
2+
from pygments.lexers.web import PhpLexer
3+
4+
lexers['php'] = PhpLexer(startinline=True, linenos=1)
5+
lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
6+
7+
# Configuration file for the Sphinx documentation builder.
8+
#
9+
# For the full list of built-in configuration values, see the documentation:
10+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
11+
12+
# -- Project information -----------------------------------------------------
13+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
14+
15+
project = 'jwt-auth'
16+
copyright = '2025, James Read'
17+
author = 'James Read'
18+
release = '3.0.0'
19+
20+
# -- General configuration ---------------------------------------------------
21+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
22+
23+
extensions = [
24+
'sphinx.ext.autodoc',
25+
'sphinx.ext.doctest',
26+
'sphinx.ext.todo',
27+
'sphinx.ext.coverage',
28+
'sphinx.ext.imgmath',
29+
'sphinx.ext.viewcode',
30+
'sphinx.ext.githubpages',
31+
'sphinx.ext.napoleon',
32+
'sphinx_rtd_theme',
33+
'sphinx_multiversion',
34+
]
35+
36+
templates_path = ['_templates']
37+
exclude_patterns = ['.venv', 'bin', 'build', 'include', 'lib','lib64']
38+
39+
root_doc = 'index'
40+
41+
# -- Options for HTML output -------------------------------------------------
42+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
43+
html_theme = 'sphinx_rtd_theme'
44+
highlight_language = "php"
45+
46+
smv_tag_whitelist = r'^.*$'
47+
smv_branch_whitelist = r'^(\d\.x|main)$'
48+
smv_remote_whitelist = r'^.*$'
49+
smv_released_pattern = r'^tags/.*$'
50+
smv_outputdir_format = '{ref.name}'
51+
smv_prefer_remote_refs = False

docs/pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ readme = "../README.md"
66
requires-python = ">=3.11"
77
dependencies = [
88
"pygments>=2.19.2",
9-
"sphinx>=8.1.3",
10-
"sphinx-multiversion>=0.2.4",
9+
"sphinx>=9.0.4",
10+
"sphinx-multiversion-scylla>=0.3.7",
1111
"sphinx-rtd-theme>=3.0.2",
12-
]
12+
]

docs/requirements.txt

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)