joeced
commented
6 years ago Which version of sphinxcontrib-matlabdomain did you use? Plus can I see your conf.py.
Closed kubasikus closed 6 years ago
joeced
commented
6 years ago Which version of sphinxcontrib-matlabdomain did you use? Plus can I see your conf.py.
kubasikus
commented
6 years ago 0.2.16
import os
# -- Path setup --------------------------------------------------------------
matlab_src_dir=os.path.abspath('..')
# -- Project information -----------------------------------------------------
project = 'project'
copyright = '2018, Jmicanek'
author = 'Jmicanek'
# The short X.Y version
version = '0.1'
# The full version, including alpha/beta/rc tags
release = 'TBD'
# -- General configuration ---------------------------------------------------
extensions = [
'sphinx.ext.viewcode',
'sphinx.ext.autodoc',
'sphinxcontrib.matlab',
'sphinx.ext.todo',
'sphinx.ext.coverage',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
source_suffix = '.mat'
master_doc = 'index'
language = None
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------
html_theme = 'alabaster'
# 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.
#
# 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 ---------------------------------------------
htmlhelp_basename = 'xxx'
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'xxx', 'xxx Documentation',
[author], 1)
]
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = TrueThe issue is that you are missing the matlab_src_dir = os.path.abspath('..') (or where your MATLAB module is stored). But, it should not fail like that, so I can confirm it is a bug.
kubasikus
commented
6 years ago matlab_src_dir=os.path.abspath('..') is actually there in the # -- Path setup section.
joeced
commented
6 years ago Sorry overlooked it. Maybe its another issue, but I cannot reproduce it. Can you send me a minimal example?
tk0miya
commented
6 years ago This might be a bug of Sphinx.
File "/usr/local/lib/python3.5/dist-packages/sphinx/ext/autodoc/directive.py", line 61, in warn
logger.warning(msg, line=self.lineno)Please update your Sphinx to 1.7.2 and try it again.
joeced
commented
6 years ago Can't seem to reproduce after using Sphinx >= 1.7.2.
Hello, I'm trying to use this package for MATLAB code documentation. Often times when there is some kind of problem, i get these error messages about some log function which received wrong input. Is this supposed to happen, or is it just my bad code?
Thanks!