summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py36
1 files changed, 15 insertions, 21 deletions
diff --git a/docs/conf.py b/docs/conf.py
index f46d1f7..1258a42 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
#
# docker-sdk-python documentation build configuration file, created by
# sphinx-quickstart on Wed Sep 14 15:48:58 2016.
@@ -34,24 +33,19 @@ sys.path.insert(0, os.path.abspath('..'))
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
+ 'myst_parser'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
-from recommonmark.parser import CommonMarkParser
-
-source_parsers = {
- '.md': CommonMarkParser,
+source_suffix = {
+ '.rst': 'restructuredtext',
+ '.txt': 'markdown',
+ '.md': 'markdown',
}
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-source_suffix = ['.rst', '.md']
-# source_suffix = '.md'
-
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
@@ -60,28 +54,28 @@ source_suffix = ['.rst', '.md']
master_doc = 'index'
# General information about the project.
-project = u'Docker SDK for Python'
+project = 'Docker SDK for Python'
year = datetime.datetime.now().year
-copyright = u'%d Docker Inc' % year
-author = u'Docker Inc'
+copyright = '%d Docker Inc' % year
+author = 'Docker Inc'
# 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.
#
-with open('../docker/version.py', 'r') as vfile:
+with open('../docker/version.py') as vfile:
exec(vfile.read())
# The full version, including alpha/beta/rc tags.
release = version
# The short X.Y version.
-version = '{}.{}'.format(version_info[0], version_info[1])
+version = f'{version_info[0]}.{version_info[1]}'
# 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
+language = 'en'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
@@ -283,8 +277,8 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'docker-sdk-python.tex', u'docker-sdk-python Documentation',
- u'Docker Inc.', 'manual'),
+ (master_doc, 'docker-sdk-python.tex', 'docker-sdk-python Documentation',
+ 'Docker Inc.', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -325,7 +319,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- (master_doc, 'docker-sdk-python', u'docker-sdk-python Documentation',
+ (master_doc, 'docker-sdk-python', 'docker-sdk-python Documentation',
[author], 1)
]
@@ -340,7 +334,7 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'docker-sdk-python', u'docker-sdk-python Documentation',
+ (master_doc, 'docker-sdk-python', 'docker-sdk-python Documentation',
author, 'docker-sdk-python', 'One line description of project.',
'Miscellaneous'),
]