docs/conf.py - master - githubmirror/commcare-hq

docs/conf.py
107 строк3 KB
Amit Phulera
lint
19 июн 2023, 13:05
19 июн 2023, 13:050ae1361
#
# CommCareHQ documentation build configuration file, created by
# sphinx-quickstart on Wed Sep  3 09:42:11 2014.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import os
import sys

sys.path.insert(0, os.path.abspath('..'))

import settings  # noqa: E402
from manage import init_hq_python_path, run_patches  # noqa: E402

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
# this avoids having to import corehq.util.log.HQRequestFilter which has a chained dependency
# to OpenSSL
settings.LOGGING = {}
init_hq_python_path()
run_patches()

# -- Custom configuration -----------------------------------------------------

# mock out stubborn modules that are hard to pip install
# https://docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
autodoc_mock_imports = ["OpenSSL", "onelogin"]

# The suffix of source filenames.
source_suffix = ['.rst', '.md']


# -- 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',
    'sphinx.ext.viewcode',
    'sphinxcontrib_django',
    'sphinx_rtd_theme',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'CommCareHQ'
copyright = '2020, Dimagi'

version = '1.0'
release = '1.0'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']

# 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.
#  html_theme = 'default'
html_theme = "sphinx_rtd_theme"

# Output file base name for HTML help builder.
htmlhelp_basename = 'CommCareHQdoc'


# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [('index', 'CommCareHQ.tex', 'CommCareHQ Documentation', 'Dimagi', 'manual'), ]

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'commcarehq', 'CommCareHQ Documentation',
     ['Dimagi'], 1)
]

# -- Options for Texinfo output ------------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [('index', 'CommCareHQ', 'CommCareHQ Documentation',
   'Dimagi', 'CommCareHQ', 'One line description of project.',
   'Miscellaneous'), ]