mirror of
https://github.com/deesiigneer/pyspapi.git
synced 2026-04-20 12:35:26 +00:00
feat(docs): localize documentation to Russian and update Makefile for Sphinx
This commit is contained in:
68
docs/conf.py
68
docs/conf.py
@@ -1,59 +1,44 @@
|
||||
from re import search, MULTILINE
|
||||
from importlib.metadata import version as pkg_version
|
||||
import os
|
||||
import sys
|
||||
|
||||
project = "pyspapi"
|
||||
author = "deesiigneer"
|
||||
copyright = "2022, deesiigneer"
|
||||
|
||||
project = 'pyspapi'
|
||||
copyright = '2022, deesiigneer'
|
||||
author = 'deesiigneer'
|
||||
with open("../pyspapi/__init__.py") as f:
|
||||
match = search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), MULTILINE)
|
||||
|
||||
if not match or match.group(1) is None:
|
||||
raise RuntimeError("The version could not be resolved")
|
||||
|
||||
version = match.group(1)
|
||||
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
version = pkg_version("pyspapi")
|
||||
release = version
|
||||
|
||||
# -- General configuration
|
||||
|
||||
sys.path.insert(0, os.path.abspath(".."))
|
||||
|
||||
|
||||
extensions = [
|
||||
'sphinx.ext.duration',
|
||||
'sphinx.ext.doctest',
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.autosummary',
|
||||
'sphinx.ext.intersphinx',
|
||||
"sphinx.ext.duration",
|
||||
"sphinx.ext.doctest",
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.autosummary",
|
||||
"sphinx.ext.intersphinx",
|
||||
]
|
||||
|
||||
autodoc_member_order = "bysource"
|
||||
autodoc_typehinta = "none"
|
||||
|
||||
intersphinx_mapping = {
|
||||
'python': ('https://docs.python.org/3/', None),
|
||||
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
|
||||
}
|
||||
autosummary_generate = True
|
||||
|
||||
version_match = os.environ.get("READTHEDOCS_VERSION")
|
||||
json_url = f"https://pyspapi.readthedocs.io/ru/{version_match}/_static/switcher.json"
|
||||
|
||||
intersphinx_disabled_domains = ['std']
|
||||
language = 'en'
|
||||
locale_dirs = ["locale/"]
|
||||
|
||||
language = "ru"
|
||||
exclude_patterns = []
|
||||
html_static_path = ["_static"]
|
||||
|
||||
html_theme = "pydata_sphinx_theme"
|
||||
html_logo = "./images/logo.png"
|
||||
html_favicon = "./images/logo.ico"
|
||||
|
||||
html_theme_options = {
|
||||
"external_links": [
|
||||
{
|
||||
"url": "https://github.com/deesiigneer/pyspapi/releases",
|
||||
"name": "Changelog",
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/sp-worlds/api-docs/wiki",
|
||||
"name": "SPWorlds API Docs",
|
||||
}
|
||||
],
|
||||
"icon_links": [
|
||||
@@ -61,24 +46,27 @@ html_theme_options = {
|
||||
"name": "GitHub",
|
||||
"url": "https://github.com/deesiigneer/pyspapi",
|
||||
"icon": "fab fa-brands fa-github",
|
||||
"type": "fontawesome"
|
||||
"type": "fontawesome",
|
||||
},
|
||||
{
|
||||
"name": "Discord",
|
||||
"url": "https://discord.gg/VbyHaKRAaN",
|
||||
"icon": "fab fa-brands fa-discord",
|
||||
"type": "fontawesome"
|
||||
"type": "fontawesome",
|
||||
},
|
||||
{
|
||||
"name": "PyPi",
|
||||
"name": "PyPI",
|
||||
"url": "https://pypi.org/project/pyspapi/",
|
||||
"icon": "fab fa-brands fa-python",
|
||||
"type": "fontawesome"
|
||||
}
|
||||
"type": "fontawesome",
|
||||
},
|
||||
],
|
||||
"header_links_before_dropdown": 4,
|
||||
"show_toc_level": 1,
|
||||
"navbar_start": ["navbar-logo"],
|
||||
"navigation_with_keys": True,
|
||||
"switcher": {
|
||||
"json_url": json_url,
|
||||
"version_match": version_match,
|
||||
},
|
||||
}
|
||||
html_css_files = ["custom.css"]
|
||||
|
||||
Reference in New Issue
Block a user