Skip to content

Commit

Permalink
Update config of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@lamyj
lamyj committed Feb 1, 2024
1 parent f789f86 commit a205052
Showing 1 changed file with 7 additions and 158 deletions.
165 changes: 7 additions & 158 deletions documentation/conf.py
View file
Original file line number Diff line number Diff line change
@@ -1,34 +1,9 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Odil documentation build configuration file, created by
# sphinx-quickstart on Wed Jan 17 15:20:04 2018.
#
# 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.

# 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('.'))

import glob
import os
import re
import shutil
import subprocess

import sphinx_rtd_theme

# Make sure Doxygen is up-to-date
if os.environ.get("READTHEDOCS", None) == "True":
if not os.path.isdir(os.path.join("_build", "doxygen")):
Expand All @@ -42,33 +17,9 @@
for entry in glob.glob(os.path.join("_build", "doxygen", "html", "*")):
shutil.move(entry, os.path.join("_build", "html", "_static", "doxygen"))

# -- 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 = []

# Add any paths that contain templates here, relative to this directory.
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'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'Odil'
copyright = '2020, Julien Lamy'
author = 'Julien Lamy'
project = "Odil"
copyright = "2015-2024, Université de Strasbourg-CNRS"
author = "Julien Lamy"

# The short X.Y version
here = os.path.abspath(os.path.dirname(__file__))
Expand All @@ -80,109 +31,7 @@
# The full version, including alpha/beta/rc tags
release = version

# 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

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# 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()]

# 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 = {}

# 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']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
# html_sidebars = {
# '**': [
# 'relations.html', # needs 'show_related': True theme option to display
# 'searchbox.html',
# ]
# }


# -- Options for HTMLHelp output ------------------------------------------

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


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

latex_elements = {
# 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',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Odil.tex', 'Odil Documentation',
'Julien Lamy', '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, 'odil', 'Odil Documentation',
[author], 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 = [
(master_doc, 'Odil', 'Odil Documentation',
author, 'Odil', 'A C++11 library for the DICOM standard',
'Miscellaneous'),
]
html_theme = "furo"
html_static_path = ["_static"]
html_css_files = ["css/style.css"]
html_title = project

0 comments on commit a205052

Please sign in to comment.