Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# data
include templateflow/conf/config.json
include templateflow/conf/templateflow-skel.zip
include templateflow/conf/templateflow-skel.md5

# misc
include requirements.txt
Expand Down
109 changes: 59 additions & 50 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@

from templateflow import __version__, __copyright__, __packagename__

sys.path.append(os.path.abspath('sphinxext'))
sys.path.append(os.path.abspath("sphinxext"))

# -- Project information -----------------------------------------------------
project = __packagename__
copyright = __copyright__
author = 'The TemplateFlow Developers'
author = "The TemplateFlow Developers"

# The short X.Y version
version = Version(__version__).public
Expand All @@ -31,29 +31,29 @@

# -- General configuration ---------------------------------------------------
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinxcontrib.apidoc',
'sphinxcontrib.napoleon'
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"sphinx.ext.intersphinx",
"sphinx.ext.coverage",
"sphinx.ext.mathjax",
"sphinx.ext.ifconfig",
"sphinx.ext.viewcode",
"sphinx.ext.githubpages",
"sphinxcontrib.apidoc",
"sphinxcontrib.napoleon",
]

autodoc_mock_imports = [
'matplotlib',
'nilearn',
'nipy',
'nitime',
'numpy',
'pandas',
'seaborn',
'skimage',
'svgutils',
'transforms3d',
"matplotlib",
"nilearn",
"nipy",
"nitime",
"numpy",
"pandas",
"seaborn",
"skimage",
"svgutils",
"transforms3d",
]

# Accept custom section names to be parsed for numpy-style docstrings
Expand All @@ -62,21 +62,21 @@
# https://github.com/sphinx-contrib/napoleon/pull/10 is merged.
napoleon_use_param = False
napoleon_custom_sections = [
('Inputs', 'Parameters'),
('Outputs', 'Parameters'),
("Inputs", "Parameters"),
("Outputs", "Parameters"),
]

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

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = ".rst"

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -89,8 +89,12 @@
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
'_build', 'Thumbs.db', '.DS_Store',
'api/modules.rst', 'api/templateflow.rst']
"_build",
"Thumbs.db",
".DS_Store",
"api/modules.rst",
"api/templateflow.rst",
]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
Expand All @@ -101,7 +105,7 @@
# 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 = "sphinx_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
Expand All @@ -112,7 +116,7 @@
# 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_static_path = ["_static"]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand All @@ -128,7 +132,7 @@
# -- Options for HTMLHelp output ---------------------------------------------

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


# -- Options for LaTeX output ------------------------------------------------
Expand All @@ -137,15 +141,12 @@
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
Expand All @@ -155,19 +156,21 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'templateflow.tex', 'TemplateFlow Documentation',
'The TemplateFlow Developers', 'manual'),
(
master_doc,
"templateflow.tex",
"TemplateFlow Documentation",
"The TemplateFlow Developers",
"manual",
),
]


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'templateflow', 'TemplateFlow Documentation',
[author], 1)
]
man_pages = [(master_doc, "templateflow", "TemplateFlow Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------------
Expand All @@ -176,9 +179,15 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'templateflow', 'TemplateFlow Documentation',
author, 'TemplateFlow', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"templateflow",
"TemplateFlow Documentation",
author,
"TemplateFlow",
"One line description of project.",
"Miscellaneous",
),
]


Expand All @@ -197,21 +206,21 @@
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
epub_exclude_files = ["search.html"]


# -- Extension configuration -------------------------------------------------

apidoc_module_dir = '../templateflow'
apidoc_output_dir = 'api'
apidoc_excluded_paths = ['conftest.py', '*/tests/*', 'tests/*', 'data/*']
apidoc_module_dir = "../templateflow"
apidoc_output_dir = "api"
apidoc_excluded_paths = ["conftest.py", "*/tests/*", "tests/*", "data/*"]
apidoc_separate_modules = True
apidoc_extra_args = ['--module-first', '-d 1', '-T']
apidoc_extra_args = ["--module-first", "-d 1", "-T"]

# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
intersphinx_mapping = {"https://docs.python.org/": None}

# -- Options for versioning extension ----------------------------------------
scv_show_banner = True
Loading