Warning message after sphinx upgrade

21 views
Skip to first unread message

Jalba sung

unread,
Jun 5, 2020, 4:12:52 AM6/5/20
to sphinx-users
Hi,

I've been using sphinx v1.7.6 and recently upgraded to v3.0.3

I used conda install to upgrade.
After this when I run 'make html' or 'make latexpdf'  I get follwing mesage 

Running Sphinx v3.0.3
WARNING: Support for evaluating Python 2 syntax is deprecated and will be removed in Sphinx 4.0. Convert /Users/Him2/Documents/My_files/sphinx/source/conf.py to Python 3 syntax.
loading translations [ko]... done
loading pickled environment... done

 below is my conf.py 

project = 'Manual'
copyright = ''
author = ''
version = '1.0'
release = 'beta'


# -- General configuration ---------------------------------------------------
extensions = [
    'sphinx.ext.viewcode',
    'sphinx.ext.githubpages',
]

templates_path = ['_templates']

source_suffix = '.rst'

master_doc = 'index'
language = None
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'


# -- Options for HTML output -------------------------------------------------
html_theme = 'alabaster'

html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


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

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


# -- Options for LaTeX output ------------------------------------------------
latex_engine = 'xelatex'
latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
         'papersize': 'a4paper',

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

    # Additional stuff for the LaTeX preamble.
    'preamble': '\usepackage{kotex}',

    # Latex figure (float) alignment
    'figure_align': 'htbp',

    # kotex config
    '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, 'Manual.tex', 'Manual Documentation',
     '', '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, 'manual', 'Manual 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, 'Manual', 'Manual Documentation',
     author, 'Manual', 'One line description of project.',
     'Miscellaneous'),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

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

# -- Extension configuration -------------------------------------------------
locale_dirs = ['locale/'] #path is example but recommended
gettext_compact = False 

# -- option for PDF output ---------------------------------------------------
pdf_documents = [('index', u'rst2pdf', u'Sample rst2pdf doc', u'Your Name'),]


What do I need to change to have the Warning message diappear?
Thank you

Komiya Takeshi

unread,
Jun 5, 2020, 10:01:16 AM6/5/20
to sphinx...@googlegroups.com
Hi,

Since python3, \u has been considered as unicode-escape sequence. So
you need to escape it like '\\usepackage'.

> 'preamble': '\usepackage{kotex}',

FYI: The raw string also helps you (ex. r'\usepackage{kotex}' ).

Thanks,
Takeshi KOMIYA

2020年6月5日(金) 17:12 Jalba sung <jalb...@gmail.com>:
> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/93a12793-c2d4-489e-8799-5b246698db88o%40googlegroups.com.
Reply all
Reply to author
Forward
Message has been deleted
0 new messages