conf.py

# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'PRAIS4 Reporting Manual'
copyright = '2021, UNCCD'
author = 'UNCCD'


# -- General configuration ---------------------------------------------------

# 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.autosummary',
    'sphinxnotes.strike',
    'linuxdoc.rstFlatTable', # https://return42.github.io/linuxdoc/linuxdoc-howto/table-markup.html#flat-table
    # 'sphinx.ext.mathjax', # https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.mathjax
    'sphinx.ext.ifconfig', # https://www.sphinx-doc.org/en/master/usage/extensions/ifconfig.html
]

myst_enable_extensions = [
    "deflist", # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
    "dollarmath", # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#math-shortcuts
    "html_image", # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#images
    "linkify", # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#linkify
    "replacements", # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#typography
    "smartquotes", # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#typography
    "substitution", # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
    "tasklist", # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#task-lists
]

myst_substitutions = {
  "br": r"""
  ```{raw} html
  <br>
  ```
  ```{raw} latex
  \mbox{}\newline
  ```
  """,
  "pagebreak": r"""
  ```{raw} latex
  \newpage
  ```
  """,
  "smallertext": r"""
  ```{rst-class} smaller-text
  ```

  ```{raw} latex
    \small
  ```
  """,
  "smalltext": r"""
  ```{rst-class} small-text
  ```

  ```{raw} latex
    \scriptsize
  ```
  """
}

# See also https://pypi.org/project/cloud_sptheme/

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

# 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 = ['_build', 'build', 'Thumbs.db', '.DS_Store', '.venv', 'README.md']
# see https://github.com/sphinx-doc/sphinx/issues/2066#issuecomment-474587560

# -- 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 = 'sphinx_rtd_theme'

# 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 = [
    'css/custom.css',
    'css/rtl.css'
]

html_context = {
    'css_files': [
        '_static/custom.css',  # overrides for wide tables in RTD theme
        ],
    }

# 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 = {
    'style_nav_header_background': '#ff7100',
    'collapse_navigation': False,
    'display_version': False,
    'logo_only': True,
    'prev_next_buttons_location': 'top',
    'vcs_pageview_mode': 'edit',
    'style_external_links': True,
}

html_context = {
    "display_github": True,
    "github_user": "eaudeweb",
    "github_repo": "Prais4-reporting-manual",
    "github_version": "master",
    "conf_py_path": "/",
}

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
html_title = 'PRAIS4 Reporting Manual'

# A shorter title for the navigation bar.  Default is the same as html_title.
html_short_title = 'PRAIS4'

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'img/unccd_logo.png'

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = 'img/favicon.ico'

# see https://docs.readthedocs.io/en/stable/guides/pdf-non-ascii-languages.html
latex_engine = 'xelatex'

# latex_toplevel_sectioning='chapter'
latex_use_modindex = False

latex_elements = {
    'papersize': 'a4paper',
    'pointsize': '10pt',
    'fncychap': '',
    'fontenc': '\\usepackage{fontspec}',
    'preamble': r'''
    \usepackage[UTF8]{ctex}
    \setcounter{secnumdepth}{-1}
    \setcounter{tocdepth}{0}
    \usepackage{caption}
    \usepackage{lscape}
    \usepackage{array}
    \usepackage[none]{hyphenat}
    \usepackage[document]{ragged2e}
    \usepackage[defaultsans]{lato}
    \usepackage{inconsolata}
    \captionsetup{labelformat=empty}
    \protected\def\sphinxstyletheadfamily {\bfseries}
    \titleformat{\chapter}[display]
        {\bfseries\fontsize{16}{14}\bfseries}{\chaptertitlename\ \thechapter}{16pt}{}
    \titleformat{\section}[display]
        {\bfseries\fontsize{14}{12}\bfseries\color{black}}{\sectiontitlename\ \thesection}{14pt}{}
    \titleformat{\subsection}[display]
        {\bfseries\fontsize{12}{10}\bfseries\color{black}}{\sectiontitlename\ \thesection}{12pt}{}
    \titleformat{\subsubsection}[display]
        {\normalfont\fontsize{12}{10}\normalfont\color{black}}{\sectiontitlename\ \thesection}{11pt}{}
    \sphinxsetup{%
        InnerLinkColor={rgb}{0,0,0.94},
        OuterLinkColor={rgb}{0,0,0.94}
    }
    \fancyhf{}
    \fancypagestyle{normal}{
        \fancyhf{}
        \fancyhead{}
        \fancyfoot{}
        \fancyfoot[LE,RO]{\thepage}
    }
    ''',  # see https://texblog.org/2007/11/07/headerfooter-in-latex-with-fancyhdr/
    'figure_align': 'H',
}

pdf_documents = [
    ('index', 'PRAIS4_user_manual', 'PRAIS4 User Manual', 'UNCCD', '2021-06-15'),
]

# Enable numfig for automatic numbering of table
# Also adjust captionsetup in latex_elements for the PDF output
numfig = False

numfig_format = {
    'table': 'Table %s',
}