102 lines
3.3 KiB
Python
102 lines
3.3 KiB
Python
#!/usr/bin/env python3
|
|
|
|
import sys
|
|
import os
|
|
import sphinx_rtd_theme
|
|
|
|
from datetime import date
|
|
|
|
# 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('.'))
|
|
sys.path.insert(0, os.path.abspath(os.path.join(
|
|
os.path.dirname(os.path.realpath(__file__)), "..", "..")))
|
|
|
|
# -- 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 = [
|
|
'docs.src.manpage',
|
|
'sphinx.ext.extlinks',
|
|
]
|
|
|
|
# The suffix(es) of source filenames.
|
|
# You can specify multiple suffix as a list of string:
|
|
source_suffix = ['.rst']
|
|
|
|
# The encoding of source files.
|
|
# source_encoding = 'utf-8-sig'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = 'cdist-contrib'
|
|
copyright = 'cdist-contrib contributors'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
|
|
version = str(date.today())
|
|
release = os.popen('git rev-parse HEAD').read()
|
|
|
|
# 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 = None
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
todo_include_todos = False
|
|
|
|
# -- 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'
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'cdistcontribdoc'
|
|
|
|
# -- Options for manual page output ---------------------------------------
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
root_mandir = os.path.dirname(os.path.realpath(__file__))
|
|
mandirs = []
|
|
for mansubdir in ('man7',):
|
|
mandirs.append((os.path.join(root_mandir, mansubdir), mansubdir[-1]))
|
|
man_pages = []
|
|
for mandir, section in mandirs:
|
|
for root, dirs, files in os.walk(mandir):
|
|
for fname in files:
|
|
froot, fext = os.path.splitext(fname)
|
|
if fext == '.rst':
|
|
man_page = (os.path.join('man' + str(section), froot),
|
|
froot, '', [], section)
|
|
man_pages.append(man_page)
|
|
|
|
# man_pages = [
|
|
# ('cdist-type', 'cdist-type', 'cdist-type documentation',
|
|
# [author], 1),
|
|
# ('man7/cdist-type__file', 'cdist-type__file',
|
|
# '', [], 1),
|
|
# ('cdist-type__directory', 'cdist-type__directory',
|
|
# 'cdist-type__directory documentation', [author], 1),
|
|
# ]
|
|
|
|
# If true, show URL addresses after external links.
|
|
# man_show_urls = False
|