Skip to content

Commit ba8b840

Browse files
committed
Migrated to Furo theme.
1 parent 1176adf commit ba8b840

File tree

7 files changed

+98
-291
lines changed

7 files changed

+98
-291
lines changed

Diff for: .python-version

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.12
1+
3.11

Diff for: Pipfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ name = "pypi"
55

66
[packages]
77
sphinx = "*"
8-
sphinx-rtd-theme = "*"
98
sphinx-copybutton = "*"
109
sphinx-sitemap = "*"
10+
furo = "*"
1111

1212
[dev-packages]
1313

1414
[requires]
15-
python_version = "3.12"
15+
python_version = "3.11"

Diff for: Pipfile.lock

+40-168
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: _templates/layout.html

-78
This file was deleted.

Diff for: _templates/page.html

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{% extends "!page.html" %}
2+
3+
{% block right_sidebar %}
4+
5+
<!-- TOC -->
6+
<div>
7+
<div style="text-align: center; font-size: small; margin: 5px; color: gray">Advertisement</div>
8+
<script type="text/javascript" src="https://udbaa.com/bnr.php?section=TOC&pub=765231&format=300x250&ga=g"></script>
9+
<noscript><a href="https://yllix.com/publishers/765231" target="_blank"><img src="//ylx-aff.advertica-cdn.com/pub/300x250.png" style="border:none;margin:0;padding:0;vertical-align:baseline;" alt="ylliX - Online Advertising Network" /></a></noscript>
10+
</div>
11+
12+
{{ super() }}
13+
{% endblock right_sidebar %}
14+
15+
{% block footer %}
16+
17+
{{ super() }}
18+
19+
<div>
20+
<div style="text-align: center; font-size: small; margin: 5px; color: gray">Advertisement</div>
21+
<script type="text/javascript" src="https://udbaa.com/bnr.php?section=Bottom&pub=765231&format=728x90&ga=g"></script>
22+
<noscript><a href="https://yllix.com/publishers/765231" target="_blank"><img src="//ylx-aff.advertica-cdn.com/pub/728x90.png" style="border:none;margin:0;padding:0;vertical-align:baseline;" alt="ylliX - Online Advertising Network" /></a></noscript>
23+
</div>
24+
25+
{% endblock footer %}

Diff for: _templates/sourcelink.html

-15
This file was deleted.

Diff for: conf.py

+30-27
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,12 @@
3333
extensions = [
3434
'sphinx.ext.intersphinx',
3535
'sphinx_sitemap',
36-
'sphinx_copybutton',
37-
'sphinx_sitemap'
36+
'sphinx_copybutton'
3837
]
3938

40-
html_baseurl = "https://docs.phpmanager.xyz/"
39+
html_baseurl = "https://docs.lextudio.com/phpmanager/"
4140
sitemap_url_scheme = "{link}"
4241

43-
4442
# Add any paths that contain templates here, relative to this directory.
4543
templates_path = ['_templates']
4644

@@ -103,6 +101,7 @@
103101

104102
# The name of the Pygments (syntax highlighting) style to use.
105103
pygments_style = 'sphinx'
104+
pygments_dark_style = "monokai"
106105

107106
# A list of ignored prefixes for module index sorting.
108107
#modindex_common_prefix = []
@@ -123,39 +122,37 @@
123122
# The theme to use for HTML and HTML Help pages. See the documentation for
124123
# a list of builtin themes.
125124

126-
# This allows sphinx_rtd_theme to work locally
127-
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
128-
129-
html_context = {
130-
'on_rtd' : on_rtd,
131-
'display_github': True,
132-
'github_user': 'phpmanager',
133-
'github_repo': 'docs',
134-
'github_version': 'master/',
135-
}
136-
137-
if not on_rtd:
138-
import sphinx_rtd_theme
139-
html_theme = 'sphinx_rtd_theme'
140-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
141-
142-
#def setup(app):
143-
# app.add_stylesheet('custom.css?v=1')
144-
# app.add_javascript('helpfulness.js')
145-
146-
#html_theme = 'default'
125+
html_theme = 'furo'
147126

148127
# Theme options are theme-specific and customize the look and feel of a theme
149128
# further. For a list of options available for each theme, see the
150129
# documentation.
151-
#html_theme_options = {}
130+
html_theme_options = {
131+
"source_repository": "https://github.com/phpmanager/docs",
132+
"source_branch": "master",
133+
"source_directory": "/",
134+
"footer_icons": [
135+
{
136+
"name": "GitHub",
137+
"url": "https://github.com/phpmanager/docs",
138+
"html": "",
139+
"class": "fa-brands fa-solid fa-github fa-2x",
140+
},
141+
],
142+
}
143+
144+
html_css_files = [
145+
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css",
146+
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css",
147+
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css",
148+
]
152149

153150
# Add any paths that contain custom themes here, relative to this directory.
154151
#html_theme_path = []
155152

156153
# The name for this set of Sphinx documents. If None, it defaults to
157154
# "<project> v<release> documentation".
158-
#html_title = None
155+
html_title = "PHP Manager for IIS Documentation"
159156

160157
# A shorter title for the navigation bar. Default is the same as html_title.
161158
#html_short_title = None
@@ -394,6 +391,12 @@
394391
# 'dotnet': ('http://dotnet.readthedocs.org/en/latest', 'dotnet.inv')
395392
#}
396393

394+
feed_num_items = 15
395+
feed_skip_regex = '(.)*index'
396+
feed_base_url = 'https://docs.lextudio.com/phpmanager/'
397+
feed_description = 'PHP Manager Documentation'
398+
feed_author = 'LeXtudio Inc.'
399+
397400
def setup(app):
398401
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
399402
if not on_rtd:

0 commit comments

Comments
 (0)