This commit is contained in:
AcuGIS 2024-06-06 10:00:28 +03:00
parent 6f59097a4d
commit 9ca21ef127
4 changed files with 67 additions and 87 deletions

15
.readthedocs.yaml Normal file
View File

@ -0,0 +1,15 @@
version: "2"
build:
os: "ubuntu-22.04"
tools:
python: "3.10"
python:
install:
- requirements: docs/requirements.txt
sphinx:
configuration: docs/source/conf.py
formats: all

View File

@ -1,99 +1,56 @@
# -*- coding: utf-8 -*-
# Configuration file for the Sphinx documentation builder.
import sys
import os
import re
# -- Project information
if not 'READTHEDOCS' in os.environ:
sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.abspath('./demo/'))
project = 'Jasper Publisher'
copyright = '2024, Cited, Inc.'
author = 'Cited Inc'
from sphinx.locale import _
from sphinx_rtd_theme import __version__
release = '2.1'
version = '0.1.0'
project = u'JRI Viewer'
copyright = u'2023, Cited, Inc.'
slug = re.sub(r'\W+', '-', project.lower())
version = __version__
release = __version__
author = u'acugis'
copyright = author
language = 'en'
# -- General configuration
extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinxcontrib.httpdomain',
'sphinx_rtd_theme',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
]
templates_path = ['_templates']
source_suffix = '.rst'
exclude_patterns = []
locale_dirs = ['locale/']
gettext_compact = False
master_doc = 'index'
suppress_warnings = ['image.nonlocal_uri']
pygments_style = 'default'
intersphinx_mapping = {
'rtd': ('https://docs.readthedocs.io/en/latest/', None),
'sphinx': ('http://www.sphinx-doc.org/en/stable/', None),
'python': ('https://docs.python.org/3/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']
templates_path = ['_templates']
# -- Options for HTML output
html_theme = 'sphinx_rtd_theme'
# -- Options for EPUB output
epub_show_urls = 'footnote'
formats: all
html_static_path = ['_static']
# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
'css/custom.css',
]
pygments_style = "sphinx"
html_logo = "qwc2-docs.png"
html_theme_options = {
'logo_only': False,
'display_version': True
'logo_only': True,
'display_version': False,
}
html_theme_path = ["_themes", ]
html_logo = "_static/jri-publihser-top-icon.fw.png"
html_show_sourcelink = True
htmlhelp_basename = slug
latex_documents = [
('index', '{0}.tex'.format(slug), project, author, 'manual'),
]
man_pages = [
('index', slug, project, [author], 1)
]
texinfo_documents = [
('index', slug, project, author, slug, project, 'Miscellaneous'),
]
# Extensions to theme docs
def setup(app):
from sphinx.domains.python import PyField
from sphinx.util.docfields import Field
app.add_object_type(
'confval',
'confval',
objname='configuration value',
indextemplate='pair: %s; configuration value',
doc_field_types=[
PyField(
'type',
label=_('Type'),
has_arg=False,
names=('type',),
bodyrolename='class'
),
Field(
'default',
label=_('Default'),
has_arg=False,
names=('default',),
),
]
)

View File

@ -1,2 +1,2 @@
sphinx
sphinxcontrib-httpdomain
sphinx==7.1.2
sphinx-rtd-theme==1.3.0rc1

8
pyproject.toml Normal file
View File

@ -0,0 +1,8 @@
[build-system]
requires = ["flit_core >=3.2,<4"]
build-backend = "flit_core.buildapi"
[project]
name = "QatMaps"
authors = [{name = "AcuGIS", email = "hello@citedcorp.com"}]
dynamic = ["version", "description"]