mirror of
https://github.com/nextcloud/documentation.git
synced 2025-12-12 07:29:47 +07:00
156 lines
4.9 KiB
Python
156 lines
4.9 KiB
Python
## These are the configuration elements for the Nextcloud User Manual documentation
|
||
#
|
||
# Configuration file for the Sphinx documentation builder.
|
||
#
|
||
# For the full list of built-in configuration values, see the documentation:
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||
#
|
||
## Note that additional configuration elements shared by all Nextcloud docs
|
||
## are loaded from `../conf.py`.
|
||
|
||
# -- Path setup --------------------------------------------------------------
|
||
|
||
import os
|
||
import sys
|
||
|
||
# Import Nextcloud's shared global documentation configuration (from parent)
|
||
sys.path.insert(0, os.path.abspath('../'))
|
||
from conf import *
|
||
|
||
# -- Project information -----------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||
|
||
project = u'Nextcloud %s User Manual' % (version)
|
||
|
||
# -- General configuration ---------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||
|
||
# Note: `+=` must be used here because we're extending the inherited list of extensions from our global docs config
|
||
|
||
extensions += [
|
||
'sphinx.ext.todo',
|
||
'rst2pdf.pdfbuilder',
|
||
'sphinx.ext.intersphinx',
|
||
]
|
||
|
||
templates_path = [
|
||
'../_shared_assets/templates',
|
||
'_templates',
|
||
]
|
||
|
||
|
||
exclude_patterns = [
|
||
'_build',
|
||
]
|
||
|
||
# use a dedicated file for our main (root) toctree.
|
||
root_doc = 'contents'
|
||
|
||
## Internationalization
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-internationalisation
|
||
# directories in which to search for additional message catalogs (default is ['locales`])
|
||
locale_dirs = ['locale/']
|
||
# set a document’s text domain to the docname, in full (default is True)
|
||
gettext_compact = False
|
||
|
||
## Markup
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-markup
|
||
# a substitution that will be included in every source file
|
||
rst_epilog = '.. |version| replace:: %s' % version
|
||
|
||
# -- Options for HTML output -------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||
|
||
html_theme_path = ['../_shared_assets/themes']
|
||
html_static_path = ['../_shared_assets/static']
|
||
# prefer a shorter title for the navigation bar.
|
||
html_short_title = "User Manual"
|
||
# disable "Created using Sphinx" in the HTML footer (default is True)
|
||
html_show_sphinx = False
|
||
# disable including the reST sources in the HTML build as _sources/name (default is True)
|
||
html_copy_source = False
|
||
|
||
# -- Options for HTML help output --------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-help-output
|
||
|
||
# output file base name for HTML help builder.
|
||
htmlhelp_basename = 'NextcloudUserManual'
|
||
|
||
# -- Options for EPUB output -------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-epub-output
|
||
|
||
epub_title = u'Nextcloud User Manual'
|
||
epub_author = u'The Nextcloud developers'
|
||
epub_publisher = u'The Nextcloud developers'
|
||
epub_copyright = u'2012-2025, The Nextcloud developers'
|
||
|
||
# -- Options for LaTeX output ------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-latex-output
|
||
|
||
|
||
latex_elements = {
|
||
}
|
||
latex_documents = [
|
||
(
|
||
'contents',
|
||
'Nextcloud_User_Manual.tex',
|
||
u'Nextcloud User Manual',
|
||
u'The Nextcloud developers',
|
||
'manual',
|
||
),
|
||
]
|
||
latex_logo = '../_shared_assets/static/logo-blue.pdf'
|
||
|
||
# -- Options for manual page output ------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-manual-page-output
|
||
|
||
man_pages = [
|
||
(
|
||
'contents',
|
||
'nextcloudusermanual',
|
||
u'Nextcloud User Manual',
|
||
[u'The Nextcloud developers'],
|
||
1,
|
||
)
|
||
]
|
||
|
||
# -- Options for Texinfo output ----------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-texinfo-output
|
||
|
||
texinfo_documents = [
|
||
(
|
||
'contents',
|
||
'NextcloudUserManual',
|
||
u'Nextcloud User Manual',
|
||
u'The Nextcloud developers',
|
||
'Nextcloud',
|
||
'The Nextcloud User Manual.',
|
||
'Miscellaneous',
|
||
),
|
||
]
|
||
|
||
# -- Options for todo extension ----------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
|
||
|
||
todo_include_todos = True
|
||
|
||
# -- Options for PDF page output ---------------------------------------------
|
||
# https://rst2pdf.org/manual.html#sphinx
|
||
|
||
pdf_documents = [
|
||
(
|
||
'contents',
|
||
u'NextcloudUserManual',
|
||
u'Nextcloud User Manual',
|
||
u'The Nextcloud developers',
|
||
),
|
||
]
|
||
|
||
# Generate the versions list for inclusion into all HTML pages
|
||
current_docs = 'user_manual'
|
||
html_context['versions'] = generateVersionsDocs(current_docs)
|
||
html_context['theme_vcs_pageview_mode'] += current_docs
|
||
html_context['available_languages'] = [
|
||
]
|
||
|