diff --git a/docs/sphinx-docs/source/conf.py b/docs/sphinx-docs/source/conf.py index dd3fb7f090..5bf6e96f42 100644 --- a/docs/sphinx-docs/source/conf.py +++ b/docs/sphinx-docs/source/conf.py @@ -14,42 +14,39 @@ import os import sys -import sphinx - from sas.system.version import __version_parsed__ as sasview_version # 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. sys.path.insert(0, "../../../src") -sys.path.insert(0, os.path.abspath('_extensions')) # for sphinx extensions -print ("-- path --") -print ("\n".join(sys.path)) +sys.path.insert(0, os.path.abspath("_extensions")) # for sphinx extensions +print("-- path --") +print("\n".join(sys.path)) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# 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 = ['sphinx.ext.autodoc', - 'sphinx.ext.todo', - 'sphinx.ext.coverage', - 'sphinx.ext.mathjax', - #'mathjax', # replacement mathjax that allows a list of paths - 'dollarmath', - #'sphinx.ext.viewcode', - 'matplotlib.sphinxext.roles', # For mpltype in Plotting/Arrow3D.py - ] - -no_highlight = os.environ.get('SAS_NO_HIGHLIGHT', '0') # Check if sphinx highlighting is disabled in this environment -if no_highlight == '1': - extensions.append('sphinx.ext.viewcode') - -mathjax_path = ( - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?' - 'config=TeX-MML-AM_CHTML') +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.todo", + "sphinx.ext.coverage", + "sphinx.ext.mathjax", + #'mathjax', # replacement mathjax that allows a list of paths + "dollarmath", + #'sphinx.ext.viewcode', + "matplotlib.sphinxext.roles", # For mpltype in Plotting/Arrow3D.py +] + +no_highlight = os.environ.get("SAS_NO_HIGHLIGHT", "0") # Check if sphinx highlighting is disabled in this environment +if no_highlight == "1": + extensions.append("sphinx.ext.viewcode") + +mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML" # For katex uncomment the following """ @@ -65,21 +62,21 @@ # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = {'.rst': 'restructuredtext'} +source_suffix = {".rst": "restructuredtext"} # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. year = datetime.datetime.now().year -project = 'SasView' -copyright = f'{year}, The SasView Project' +project = "SasView" +copyright = f"{year}, The SasView Project" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -94,13 +91,13 @@ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -109,120 +106,121 @@ # the build directory. Exclude the appropriate *.rst files here so # that we don't get various "ImportError: No module named ___" when # running Sphinx. -exclude_patterns = ["*sas.sasgui.perspectives.simulation.rst", - "*sas.sascalc.pr.c_extensions.rst", - "*sas.sascalc.realspace.rst", - "*sas.sascalc.simulation.rst", - "*sas.sasview.setup_exe.rst", - "*sas.sasview.setup_mac.rst", - "*sas.sasgui.guiframe.custom_pstats.rst", # pstats not in standard library on Ubuntu out of the box - ] +exclude_patterns = [ + "*sas.sasgui.perspectives.simulation.rst", + "*sas.sascalc.pr.c_extensions.rst", + "*sas.sascalc.realspace.rst", + "*sas.sascalc.simulation.rst", + "*sas.sasview.setup_exe.rst", + "*sas.sasview.setup_mac.rst", + "*sas.sasgui.guiframe.custom_pstats.rst", # pstats not in standard library on Ubuntu out of the box +] -autodoc_mock_import = ['sip'] +autodoc_mock_import = ["sip"] # The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = 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 = 'default' -qthelp_theme = 'default' +html_theme = "default" +qthelp_theme = "default" # 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 = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # 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'] +html_static_path = ["_static"] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'SasViewdoc' +htmlhelp_basename = "SasViewdoc" # Turn off permalinks, which are a nice feature for the docs when viewed in a # browser, but which look weird (and cannot be "right-click->copy url") in @@ -233,7 +231,7 @@ # -- Options for LaTeX output -------------------------------------------------- # TODO: seems like angstroms is defined twice. -LATEX_PREAMBLE=r""" +LATEX_PREAMBLE = r""" \usepackage[utf8]{inputenc} % Allow unicode symbols in text \newcommand{\lt}{<} % HTML needs \lt rather than < \newcommand{\gt}{>} % HTML needs \gt rather than > @@ -244,56 +242,49 @@ \DeclareUnicodeCharacter {00B0} {\ensuremath{^\circ}} % degrees """ latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -'papersize': 'a4paper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -'preamble': LATEX_PREAMBLE - + # The paper size ('letterpaper' or 'a4paper'). + "papersize": "a4paper", + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + "preamble": LATEX_PREAMBLE, } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'SasView.tex', 'SasView Documentation', - 'The SasView Project', 'manual'), + ("index", "SasView.tex", "SasView Documentation", "The SasView Project", "manual"), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'sasview', 'SasView Documentation', - ['The SasView Project'], 1) -] +man_pages = [("index", "sasview", "SasView Documentation", ["The SasView Project"], 1)] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ @@ -302,36 +293,47 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'SasView', 'SasView Documentation', - 'The SasView Project', 'SasView', 'One line description of project.', - 'Miscellaneous'), + ( + "index", + "SasView", + "SasView Documentation", + "The SasView Project", + "SasView", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False -if os.path.exists('rst_prolog'): - with open('rst_prolog') as fid: +if os.path.exists("rst_prolog"): + with open("rst_prolog") as fid: rst_prolog = fid.read() numfig = True -if sphinx.version_info[0] >= 3: # CRUFT - # Skip the monkey-patched 'sas.models' which grafts the sasmodels classes - # back into their old location in sasview, but causes autodoc to explode. - def autodoc_skip_member_handler(app, what, name, obj, skip, options): - return name.startswith("sas.models") +def autodoc_skip_member_handler(app, what, name, obj, would_skip, options): + """customise which functions are included in the apidocs + + returns True to indicate that an item should be skipped + """ + if name.startswith("sas.models"): + return True + + return would_skip + - def setup(app): - # Connect the autodoc-skip-member event from apidoc to the callback - app.connect('autodoc-skip-member', autodoc_skip_member_handler) +def setup(app): + # Connect the autodoc-skip-member event from apidoc to the callback + app.connect("autodoc-skip-member", autodoc_skip_member_handler)