mirror of
https://github.com/samschott/maestral.git
synced 2024-09-22 19:42:53 +03:00
77 lines
2.0 KiB
Python
77 lines
2.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
import os
|
|
import sys
|
|
import time
|
|
|
|
sys.path.insert(0, os.path.abspath('.'))
|
|
sys.path.insert(0, os.path.abspath('..'))
|
|
sys.path.insert(0, os.path.abspath('../maestral'))
|
|
|
|
from maestral import __author__, __version__ # noqa: E402
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'Maestral'
|
|
title = 'Maestral API Documentation'
|
|
copyright = '{}, {}'.format(time.localtime().tm_year, __author__)
|
|
author = __author__
|
|
version = __version__
|
|
release = __version__
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.coverage',
|
|
'sphinx.ext.mathjax',
|
|
'sphinx.ext.ifconfig',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.githubpages',
|
|
'm2r',
|
|
'sphinx_click.ext',
|
|
]
|
|
|
|
templates_path = ['_templates']
|
|
|
|
source_suffix = ['.rst', '.md']
|
|
master_doc = 'index'
|
|
language = None
|
|
pygments_style = None
|
|
|
|
autodoc_member_order = 'bysource'
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
html_logo = '../maestral/resources/maestral.png'
|
|
|
|
html_context = {
|
|
'css_files': [
|
|
'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
|
|
'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
|
|
'_static/custom.css',
|
|
],
|
|
}
|
|
|
|
# -- Options for LaTeX output ------------------------------------------------
|
|
|
|
latex_documents = [(master_doc, 'maestral.tex', title, author, 'manual'), ]
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
|
|
# -- Options for intersphinx extension ---------------------------------------
|
|
|
|
intersphinx_mapping = {'https://docs.python.org/': None}
|
|
|
|
# -- Options for todo extension ----------------------------------------------
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
todo_include_todos = True
|