Skip to content

Commit

Permalink
Migrated to Furo theme.
Browse files Browse the repository at this point in the history
  • Loading branch information
lextm committed Mar 19, 2024
1 parent 77e85d0 commit aa37f7e
Show file tree
Hide file tree
Showing 8 changed files with 168 additions and 368 deletions.
18 changes: 6 additions & 12 deletions .github/workflows/azure-static-web-apps-purple-smoke-03003800f.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ on:
push:
branches:
- master
pull_request:
types: [opened, synchronize, reopened, closed]
branches:
- master

jobs:
build_and_deploy_job:
Expand All @@ -19,19 +15,17 @@ jobs:
with:
submodules: true
# Install Python
- name: Set up Python 3.8
- name: Set up Python 3.11
uses: actions/setup-python@v2
with:
python-version: 3.8
# Install Sphinx
- name: Set up Sphinx
uses: BSFishy/pip-action@v1
with:
packages: sphinx sphinx-autobuild sphinx_rtd_theme
python-version: 3.11

# Build the docs
- name: Build the docs
run: make html
run: |
python -m pip install pipenv
python -m pipenv install
python -m pipenv run make html
- name: Build And Deploy
id: builddeploy
Expand Down
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.11
5 changes: 3 additions & 2 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ name = "pypi"

[packages]
esbonio = "*"
sphinx-rtd-theme = "*"
sphinx-sitemap = "*"
sphinx-copybutton = "*"

[dev-packages]

[requires]
python_version = "3.7"
python_version = "3.11"
354 changes: 110 additions & 244 deletions Pipfile.lock

Large diffs are not rendered by default.

74 changes: 0 additions & 74 deletions manager/_templates/layout.html

This file was deleted.

25 changes: 25 additions & 0 deletions manager/_templates/page.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{% extends "!page.html" %}

{% block right_sidebar %}

<!-- TOC -->
<div>
<div style="text-align: center; font-size: small; margin: 5px; color: gray">Advertisement</div>
<script type="text/javascript" src="https://udbaa.com/bnr.php?section=TOC&pub=765231&format=300x250&ga=g"></script>
<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>
</div>

{{ super() }}
{% endblock right_sidebar %}

{% block footer %}

{{ super() }}

<div>
<div style="text-align: center; font-size: small; margin: 5px; color: gray">Advertisement</div>
<script type="text/javascript" src="https://udbaa.com/bnr.php?section=Bottom&pub=765231&format=728x90&ga=g"></script>
<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>
</div>

{% endblock footer %}
15 changes: 0 additions & 15 deletions manager/_templates/sourcelink.html

This file was deleted.

44 changes: 23 additions & 21 deletions manager/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,14 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.intersphinx'
'sphinx.ext.intersphinx',
"sphinx_sitemap",
"sphinx_copybutton",
]

html_baseurl = "https://docs.lextudio.com/jexusmanager/"
sitemap_url_scheme = "{link}"

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

Expand Down Expand Up @@ -96,6 +101,7 @@

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

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
Expand All @@ -116,35 +122,31 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.

# This allows sphinx_rtd_theme to work locally
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

html_context = {
'on_rtd' : on_rtd,
'display_github': True,
'github_user': 'jexuswebserver',
'github_repo': 'jexus_docs',
'github_version': 'master/manager/',
}

if not on_rtd:
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

#html_theme = 'default'
html_theme = 'furo'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
html_theme_options = {
"source_repository": "https://github.com/jexuswebserver/jexus_docs",
"source_branch": "master",
"source_directory": "manager/",
"footer_icons": [
{
"name": "GitHub",
"url": "https://github.com/jexuswebserver/jexus_docs",
"html": "",
"class": "fa-brands fa-solid fa-github fa-2x",
},
],
}

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

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
html_title = "Jexus Manager Documentation"

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
Expand Down Expand Up @@ -384,7 +386,7 @@

feed_num_items = 15
feed_skip_regex = '(.)*index'
feed_base_url = 'https://docs.jexusmanager.com/'
feed_base_url = 'https://docs.lextudio.com/jexusmanager/'
feed_description = 'Jexus Manager Documentation'
feed_author = 'LeXtudio Inc.'

Expand Down

0 comments on commit aa37f7e

Please sign in to comment.