platypush/docs/source/conf.py

227 lines
6.4 KiB
Python
Raw Normal View History

2018-06-23 01:00:43 +02:00
import os
import sys
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
sys.path.insert(0, os.path.abspath("./_ext"))
2018-06-23 01:00:43 +02:00
# -- Project information -----------------------------------------------------
project = 'Platypush'
copyright = '2017-2024, Fabio Manganiello'
2023-09-29 18:08:16 +02:00
author = 'Fabio Manganiello <fabio@manganiello.tech>'
2018-06-23 01:00:43 +02:00
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = ''
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'myst_parser',
2018-06-23 01:00:43 +02:00
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
2020-01-09 23:40:59 +01:00
'sphinx_rtd_theme',
'sphinx_marshmallow',
'add_dependencies',
2018-06-23 01:00:43 +02:00
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = ['.rst', '.md']
# source_suffix = '.rst'
2018-06-23 01:00:43 +02:00
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
2018-06-23 01:00:43 +02:00
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
2020-01-09 23:40:59 +01:00
# html_theme = 'haiku'
# html_theme = 'sphinx_rtd_theme'
html_theme = 'sphinx_book_theme'
2018-06-23 01:00:43 +02:00
html_title = 'Platypush Documentation'
html_logo = '../../assets/logo-64.png'
html_favicon = '../../platypush/backend/http/webapp/public/favicon.ico'
2018-06-23 01:00:43 +02:00
html_domain_indices = True
# 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 = {
'toc_title': 'Platypush documentation',
'repository_url': 'https://git.platypush.tech/platypush/platypush',
'repository_provider': 'github',
'use_repository_button': True,
'use_issues_button': True,
'use_fullscreen_button': True,
'home_page_in_toc': True,
}
2018-06-23 01:00:43 +02:00
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_css_files = [
'styles/custom.css',
]
html_js_files = [
'scripts/custom.js',
]
2018-06-23 01:00:43 +02:00
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {
# '**': ['logo-text.html', 'globaltoc.html', 'localtoc.html', 'searchbox.html']
# }
2018-06-23 01:00:43 +02:00
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'platypushdoc'
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
2022-08-04 03:08:54 +02:00
(master_doc, 'platypush.tex', 'platypush Documentation', 'BlackLight', 'manual'),
2018-06-23 01:00:43 +02:00
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
2022-08-04 03:08:54 +02:00
man_pages = [(master_doc, 'platypush', 'platypush Documentation', [author], 1)]
2018-06-23 01:00:43 +02:00
# -- Options for TexInfo output ----------------------------------------------
2018-06-23 01:00:43 +02:00
# Grouping the document tree into TexInfo files. List of tuples
2018-06-23 01:00:43 +02:00
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
2022-08-04 03:08:54 +02:00
(
master_doc,
'platypush',
'platypush Documentation',
author,
'platypush',
2023-05-06 23:26:07 +02:00
'A general-purpose platform for automation.',
2022-08-04 03:08:54 +02:00
'Miscellaneous',
),
2018-06-23 01:00:43 +02:00
]
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
2018-06-23 01:00:43 +02:00
autodoc_default_options = {
'members': True,
'show-inheritance': True,
'inherited-members': True,
}
2018-06-23 01:00:43 +02:00
sys.path.insert(0, os.path.abspath('../..'))
from platypush.utils.mock.modules import mock_imports # noqa
autodoc_mock_imports = [*mock_imports]
2021-09-25 01:34:45 +02:00
# _ = app
# __ = what
# ___ = obj
# ____ = options
def _skip(_, __, name, ___, skip, ____):
2018-06-23 01:00:43 +02:00
if name == "__init__":
return False
return skip
2021-09-25 01:34:45 +02:00
2018-06-23 01:00:43 +02:00
def setup(app):
app.connect("autodoc-skip-member", _skip)
2018-06-23 01:00:43 +02:00
# vim:sw=4:ts=4:et: