Skip to content

Small update to conf.py file to avoid build errors #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
deb-intel merged 1 commit into from
Apr 13, 2020
Merged

Small update to conf.py file to avoid build errors #219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
# 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' ]
exclude_patterns = ['_build','.tox' ]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
Expand Down Expand Up @@ -191,3 +191,9 @@ def setup(app):
}
breathe_default_project = "SOF Project"
breathe_default_members = ('members', 'undoc-members', 'content-only')

try:
if "tox" not in exclude_patterns:
exclude_patterns.append(".tox")
except:
exclude_patterns = [".tox"]

@marc-hb marc-hb Apr 14, 2020

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How can an exclude_patterns be anything else than the constant defined at the top?

@intelkevinputnam intelkevinputnam Apr 16, 2020

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is code is generated by another tool, which cannot assume that the list exists. If you'd prefer '.tox' can be added to the definition above. More generally, the conf.py get's executed before Sphinx runs, so any kind of Python code can be included, including registering methods with Sphinx to change the functionality of Sphinx.

@marc-hb marc-hb Apr 16, 2020

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you'd prefer '.tox' can be added to the definition above.

I don't have any preference, at least not yet, just ignorance and fear :-) I made a one-line change to this file recently (a7e77d4) and now that you say it is generated I'm afraid I didn't know what I was doing.

This is code is generated by another tool, which cannot assume that the list exists.

The comment at the top says it was generated the very first time but it doesn't seem to say anything about generating any part of it again...?

@intelkevinputnam intelkevinputnam Apr 16, 2020

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a big fan of the conf.py as it mixes concerns: setting global variables and executable code. I'd prefer a true settings file: either .ini or .json. So fear justified. ;-) The conf.py is created by sphinx-quickstart when you create a new project and is one of the few required files for Sphinx. The snippet with exclude patterns is generated by the GUI app I mentioned - Sphinx goes nuts trying to parse its own .rst docs in the .tox directory if you don't. That's why it adds it at the end, so as not to mess with other settings. Both happen exactly once, so any other changes are fine.