"python": ("https://docs.python.org/{.major}".format(sys.version_info), None), "numpy": ("https://docs.scipy.org/doc/numpy/", None), "scipy": ("https://docs.scipy.org/doc/scipy/reference", None), # "matplotlib": ("https://matplotlib.org/", None), "sklearn": ("http://scikit-learn.org/stable", None), } # sphinx-gallery configuration # sphinx_gallery_conf = { # 'doc_module': 'hummingbird', # 'backreferences_dir': os.path.join('generated'), # 'reference_url': { # 'hummingbird': None} # } def setup(app): # a copy button to copy snippet of code from the documentation app.add_js_file("js/copybutton.js") app.add_css_file("basic.css") # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( "hummingbird", "https://github.com/microsoft/" "hummingbird/blob/{revision}/hummingbird" "{package}/{path}#L{lineno}", )
def generate_example_rst(app, what, name, obj, options, lines): # generate empty examples files, so that we don't get # inclusion errors if there are no examples for a class / module examples_path = os.path.join(app.srcdir, "generated", "%s.examples" % name) if not os.path.exists(examples_path): # touch file open(examples_path, 'w').close() # Config for sphinx_issues issues_uri = 'https://github.com/pydicom/pynetdicom3/issues/{issue}' issues_github_path = 'pydicom/pynetdicom3' issues_user_uri = 'https://github.com/{user}' def setup(app): app.connect('autodoc-process-docstring', generate_example_rst) app.add_stylesheet('css/pynetdicom3.css') # Example configuration for intersphinx: refer to # the Python standard library. # intersphinx_mapping = {'http://docs.python.org/': None} # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'pynetdicom3', u'https://github.com/pydicom/' 'pynetdicom3/blob/{revision}/' '{package}/{path}#L{lineno}')
# Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'pynets', u'https://github.com/dPys/' 'pynets/blob/{revision}/' '{package}/{path}#L{lineno}') # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/': None} suppress_warnings = ["image.nonlocal_uri"] def setup(app): app.add_stylesheet('theme_overrides.css') # We need this for the boilerplate script app.add_javascript( "https://cdn.rawgit.com/chrisfilo/zenodo.js/v0.1/zenodo.js")
# https://github.com/rtfd/sphinx_rtd_theme/issues/117 def setup(app): app.add_css_file('theme_overrides.css') app.add_js_file( "https://cdn.rawgit.com/chrisfilo/zenodo.js/v0.1/zenodo.js") html_favicon = '_static/tedana_favicon.png' # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'tedanadoc' # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'tedana', u'https://github.com/me-ica/' 'tedana/blob/{revision}/' '{package}/{path}#L{lineno}') # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { "python": ("https://docs.python.org/3/", None), "numpy": ("https://numpy.org/doc/stable/", None), "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None), "matplotlib": ("https://matplotlib.org/", None), "nibabel": ("https://nipy.org/nibabel/", None), "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None), "nilearn": ("http://nilearn.github.io/", None) }
# not chapters. #latex_use_parts = False # Additional stuff for the LaTeX preamble. latex_preamble = r""" \usepackage{amsmath}\usepackage{amsfonts}\usepackage{bm}\usepackage{morefloats} \usepackage{enumitem} \setlistdepth{10} """ # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_use_modindex = True trim_doctests_flags = True def setup(app): # to hide/show the prompt in code examples: app.add_javascript('js/copybutton.js') # to format example galleries: app.add_javascript('js/examples.js') # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('sklearn_theano', u'https://github.com/sklearn-theano/' 'sklearn-theano/blob/{revision}/' '{package}/{path}#L{lineno}')
'One line description of project.', 'Miscellaneous'), ] def generate_example_rst(app, what, name, obj, options, lines): # generate empty examples files, so that we don't get # inclusion errors if there are no examples for a class / module examples_path = os.path.join(app.srcdir, "modules", "generated", "%s.examples" % name) if not os.path.exists(examples_path): # touch file open(examples_path, 'w').close() # Config for sphinx_issues issues_uri = 'https://github.com/paris-saclay-cds/specio/issues/{issue}' issues_github_path = 'paris-saclay-cds/specio' issues_user_uri = 'https://github.com/{user}' def setup(app): app.connect('autodoc-process-docstring', generate_example_rst) # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'specio', u'https://github.com/paris-saclay-cds/' 'specio/blob/{revision}/' '{package}/{path}#L{lineno}')
texinfo_documents = [ (master_doc, 'FreeDiscovery', 'FreeDiscovery Documentation', author, 'FreeDiscovery', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False required_symlinks = [('examples', '../examples/')] napoleon_google_docstring = False napoleon_numpy_docstring = True napoleon_include_init_with_doc = False autoclass_content = 'class' # don't document __init__ # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'freediscovery', u'https://github.com/FreeDiscovery/' 'FreeDiscovery/blob/{revision}/' '{package}/{path}#L{lineno}')
u'tensorlib developers', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. latex_logo = "logos/tensorlib-logo.png" # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # Additional stuff for the LaTeX preamble. latex_preamble = r""" \usepackage{amsmath}\usepackage{amsfonts}\usepackage{bm}\usepackage{morefloats} \usepackage{enumitem} \setlistdepth{10} """ # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_use_modindex = True trim_doctests_flags = True # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('tensorlib', u'https://github.com/tensorlib/' 'tensorlib/blob/{revision}/' '{package}/{path}#L{lineno}')
# 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'] # Avoid misleading warning triggered by more than one target for cross-reference class PatchedPythonDomain(PythonDomain): def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): if 'refspecific' in node: del node['refspecific'] return super(PatchedPythonDomain, self).resolve_xref( env, fromdocname, builder, typ, target, node, contnode) def setup(sphinx): sphinx.add_domain(PatchedPythonDomain, override=True) # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('skmultiflow', u'https://github.com/scikit-multiflow/' 'scikit-multiflow/blob/{revision}/src/' '{package}/{path}#L{lineno}')
# Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('rapidtide', u'https://github.com/bbfrederick/' 'rapidtide/blob/{revision}/' '{package}/{path}#L{lineno}') # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { 'http://docs.python.org/3.5': None, 'http://docs.scipy.org/doc/numpy': None, 'http://docs.scipy.org/doc/scipy/reference': None, 'http://matplotlib.org/': None, 'http://scikit-learn.org/0.17': None, 'http://nipy.org/nibabel/': None, 'http://pandas.pydata.org/pandas-docs/stable/': None, } sphinx_gallery_conf = { # path to your examples scripts
'notebooks_dir': 'examples' } } def touch_example_backreferences(app, what, name, obj, options, lines): # generate empty examples files, so that we don't get # inclusion errors if there are no examples for a class / module examples_path = os.path.join(app.srcdir, "modules", "generated", "%s.examples" % name) if not os.path.exists(examples_path): # touch file open(examples_path, 'w').close() # Add the 'copybutton' javascript, to hide/show the prompt in code # examples def setup(app): app.add_js_file('copybutton.js') app.connect('autodoc-process-docstring', touch_example_backreferences) # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'nilearn', 'https://github.com/nilearn/' 'nilearn/blob/{revision}/' '{package}/{path}#L{lineno}')
"reference_url": { "imblearn": None }, } # -- Options for github link for what's new ----------------------------------- # Config for sphinx_issues issues_uri = "https://github.com/scikit-learn-contrib/imbalanced-learn/issues/{issue}" issues_github_path = "scikit-learn-contrib/imbalanced-learn" issues_user_uri = "https://github.com/{user}" # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( "imblearn", "https://github.com/scikit-learn-contrib/" "imbalanced-learn/blob/{revision}/" "{package}/{path}#L{lineno}", ) # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples
# Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'fmriprep', u'https://github.com/poldracklab/' 'fmriprep/blob/{revision}/' '{package}/{path}#L{lineno}') # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/': None} suppress_warnings = ["image.nonlocal_uri"] def setup(app): app.add_stylesheet('theme_overrides.css') # We need this for the boilerplate script app.add_javascript( "https://cdn.rawgit.com/chrisfilo/zenodo.js/v0.1/zenodo.js")
def setup(app): app.add_stylesheet('theme_overrides.css') app.connect('autodoc-process-docstring', generate_example_rst) html_favicon = '_static/brainconn_favicon.png' # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'brainconndoc' # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('brainconn', u'https://github.com/FIU-Neuro/' 'brainconn/blob/{revision}/' '{package}/{path}#L{lineno}') # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { 'http://docs.python.org/3.5': None, 'http://docs.scipy.org/doc/numpy': None, 'http://docs.scipy.org/doc/scipy/reference': None, 'http://matplotlib.org/': None, 'http://scikit-learn.org/0.17': None, 'http://nipy.org/nibabel/': None, 'http://pandas.pydata.org/pandas-docs/stable/': None, } sphinx_gallery_conf = { # path to your examples scripts
app.add_stylesheet('theme_overrides.css') app.add_stylesheet('nimare.css') app.connect('autodoc-process-docstring', generate_example_rst) html_favicon = '_static/nimare_favicon.png' html_logo = '_static/nimare_banner.png' # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'nimaredoc' # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'nimare', u'https://github.com/neurostuff/' 'nimare/blob/{revision}/' '{package}/{path}#L{lineno}') # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { 'http://docs.python.org/3.5': None, 'http://docs.scipy.org/doc/numpy': None, 'http://docs.scipy.org/doc/scipy/reference': None, 'http://matplotlib.org/': None, 'http://scikit-learn.org/0.17': None, 'http://nipy.org/nibabel/': None, 'http://pandas.pydata.org/pandas-docs/stable/': None, } #sphinx_gallery_conf = { # path to your examples scripts
# https://github.com/rtfd/sphinx_rtd_theme/issues/117 def setup(app): app.add_stylesheet('theme_overrides.css') html_favicon = '_static/tedana_favicon.png' # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'tedanadoc' # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('tedana', u'https://github.com/me-ica/' 'tedana/blob/{revision}/' '{package}/{path}#L{lineno}') # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { 'http://docs.python.org/3.5': None, 'http://docs.scipy.org/doc/numpy': None, 'http://docs.scipy.org/doc/scipy/reference': None, 'http://matplotlib.org/': None, 'http://scikit-learn.org/0.17': None, 'http://nipy.org/nibabel/': None, 'http://pandas.pydata.org/pandas-docs/stable/': None, }
# ------ sphinx gallery ---------------------------------------------------- sphinx_gallery_conf = { 'doc_module': 'pymfe', 'backreferences_dir': os.path.join('generated'), # path to your example scripts 'examples_dirs': '../../examples', # path where to save gallery generated examples 'gallery_dirs': 'auto_examples', 'reference_url': { # The module you locally document uses None 'pymfe': None, } # 'plot_gallery': True, # 'junit': '../test-results/sphinx-gallery/junit.xml', # 'log_level': {'backreference_missing': 'warning'}, # 'subsection_order': ExplicitOrder(['../examples/sin_func', # '../examples/no_output', # '../tutorials/seaborn']) } # --- GitHun link ----------------------------------------------------------- # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'pymfe', u'https://github.com/ealcobaca/' 'pymfe/blob/{revision}/' '{package}/{path}#L{lineno}') # print(linkcode_resolve('py', {'module': 'pymfe.mfe', 'fullname': 'MFE'}))
# Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' def generate_example_rst(app, what, name, obj, options, lines): # generate empty examples files, so that we don't get # inclusion errors if there are no examples for a class / module examples_path = os.path.join(app.srcdir, "modules", "generated", "%s.examples" % name) if not os.path.exists(examples_path): # touch file open(examples_path, "w").close() def setup(app): # to hide/show the prompt in code examples: app.add_javascript("js/copybutton.js") app.connect("autodoc-process-docstring", generate_example_rst) # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( "skvideo", u"https://github.com/scikit-video/" "scikit-video/blob/{revision}/" "{package}/{path}#L{lineno}" )
"navigation_depth": 3, } html_context = { # Enable the "Edit in GitHub link within the header of each page. "display_github": True, # Set the following variables to generate the resulting github URL for each page. # Format Template: https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }} "github_user": "******", "github_repo": "mgc", "github_version": "master/docs/", } linkcode_resolve = make_linkcode_resolve( "mgc", u"https://github.com/sampan501/" "mgc/blob/{revision}/" "{package}/{path}#L{lineno}", ) # 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 ---------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'polyglot', u'polyglot Documentation', u'Rami Al-Rfou', 'polyglot', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('polyglot', u'https://github.com/aboSamoor/polyglot' '/blob/{revision}/' '{package}/{path}#L{lineno}')
f.write(searchindex_text) # Config for sphinx_issues # we use the issues path for PRs since the issues URL will forward issues_github_path = 'scikit-optimize/scikit-optimize' def setup(app): # to hide/show the prompt in code examples: app.connect('build-finished', make_carousel_thumbs) app.connect('build-finished', filter_search_index) # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'skopt', 'https://github.com/scikit-optimize/' 'scikit-optimize/blob/{revision}/' '{package}/{path}#L{lineno}') warnings.filterwarnings("ignore", category=UserWarning, message='Matplotlib is currently using agg, which is a' ' non-GUI backend, so cannot show the figure.') # Reduces the output of estimators # sklearn.set_config(print_changed_only=True) # -- Extension configuration -------------------------------------------------
# dir menu entry, description, category) texinfo_documents = [ (master_doc, 'cugraph', 'cugraph Documentation', author, 'cugraph', 'One line description of project.', 'Miscellaneous'), ] # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/': None} # Config numpydoc numpydoc_show_inherited_class_members = False numpydoc_class_members_toctree = False def setup(app): app.add_css_file('copybutton.css') app.add_css_file('params.css') app.add_css_file('references.css') source_suffix = ['.rst', '.md'] # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'cugraph', 'https://github.com/rapidsai/' 'cugraph/blob/{revision}/python/' '{package}/{path}#L{lineno}')
# 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_favicon = "_static/nimare_favicon.png" html_logo = "_static/nimare_banner.png" # ----------------------------------------------------------------------------- # HTMLHelp output # ----------------------------------------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = "nimaredoc" # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( "nimare", "https://github.com/neurostuff/nimare/blob/{revision}/" "{package}/{path}#L{lineno}", ) # ----------------------------------------------------------------------------- # intersphinx # ----------------------------------------------------------------------------- _python_version_str = "{0.major}.{0.minor}".format(sys.version_info) _python_doc_base = "https://docs.python.org/" + _python_version_str intersphinx_mapping = { "python": (_python_doc_base, None), "numpy": ("https://docs.scipy.org/doc/numpy", (None, "./_intersphinx/numpy-objects.inv")), "scipy": ( "https://docs.scipy.org/doc/scipy/reference", (None, "./_intersphinx/scipy-objects.inv"), ), "sklearn": ("https://scikit-learn.org/stable", (None, "./_intersphinx/sklearn-objects.inv")),
# we use the issues path for PRs since the issues URL will forward issues_github_path = "scikit-learn/scikit-learn" def setup(app): app.connect("builder-inited", generate_min_dependency_table) app.connect("builder-inited", generate_min_dependency_substitutions) # to hide/show the prompt in code examples: app.connect("build-finished", make_carousel_thumbs) app.connect("build-finished", filter_search_index) # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( "sklearn", "https://github.com/scikit-learn/" "scikit-learn/blob/{revision}/" "{package}/{path}#L{lineno}", ) warnings.filterwarnings( "ignore", category=UserWarning, message=( "Matplotlib is currently using agg, which is a" " non-GUI backend, so cannot show the figure." ), ) # maps functions with a class name that is indistinguishable when case is # ignore to another filename
# If true, show URL addresses after external links. #man_show_urls = False # -- 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, 'PyKrige', 'PyKrige Documentation', author, 'PyKrige', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'pykrige', u'https://github.com/bsmurphy/' 'PyKrige/blob/{revision}/' '{package}/{path}#L{lineno}')
"examples_dirs": "../../examples", # path where to save gallery generated examples "gallery_dirs": "auto_examples", "reference_url": { # The module you locally document uses None "pymfe": None, }, # 'thumbnail_size': (50, 50), # 'junit': '../test-results/sphinx-gallery/junit.xml', # 'log_level': {'backreference_missing': 'warning'}, # 'subsection_order': ExplicitOrder(['../examples/sin_func', # '../examples/no_output', # '../tutorials/seaborn']) } # --- GitHun link ----------------------------------------------------------- # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( "pymfe", u"https://github.com/ealcobaca/" "pymfe/blob/{revision}/" "{package}/{path}#L{lineno}", ) # print(linkcode_resolve('py', {'module': 'pymfe.mfe', 'fullname': 'MFE'})) # run auto pages import os os.system("python pages/run.py")
# generate empty examples files, so that we don't get # inclusion errors if there are no examples for a class / module examples_path = os.path.join(app.srcdir, "generated", "%s.examples" % name) if not os.path.exists(examples_path): # touch file open(examples_path, 'w').close() def setup(app): app.connect('autodoc-process-docstring', generate_example_rst) app.add_css_file('css/pydicom.css') # Example configuration for intersphinx: refer to # the Python standard library. # intersphinx_mapping = {'http://docs.python.org/': None} # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'pydicom', 'https://github.com/pydicom/pydicom/blob/{revision}/{package}/{path}#L{lineno}' # noqa ) doctest_global_setup = """ import pydicom import os, os.path testfile_path = os.path.join(pydicom.__path__[0], '../tests/test_files') save_dir = os.getcwd() os.chdir(testfile_path) """
] # -- 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, 'phicore', 'phicore 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, 'phicore', 'phicore Documentation', author, 'phicore', 'One line description of project.', 'Miscellaneous'), ] # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('phicore', u'https://github.com/lidyl/' 'phicore/blob/{revision}/' '{package}/{path}#L{lineno}')
# If true, show URL addresses after external links. #man_show_urls = False # -- 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 = [ ('index', 'polyglot', u'polyglot Documentation', u'Rami Al-Rfou', 'polyglot', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'polyglot', u'https://github.com/aboSamoor/polyglot' '/blob/{revision}/' '{package}/{path}#L{lineno}')
return print('Preparing carousel images') image_dir = os.path.join(app.builder.outdir, '_images') for glr_plot, max_width in carousel_thumbs.items(): image = os.path.join(image_dir, glr_plot) if os.path.exists(image): c_thumb = os.path.join(image_dir, glr_plot[:-4] + '_carousel.png') sphinx_gallery.gen_rst.scale_image(image, c_thumb, max_width, 190) # Config for sphinx_issues issues_uri = 'https://github.com/scikit-learn/scikit-learn/issues/{issue}' issues_github_path = 'scikit-learn/scikit-learn' issues_user_uri = 'https://github.com/{user}' def setup(app): # to hide/show the prompt in code examples: app.add_javascript('js/copybutton.js') app.add_javascript('js/extra.js') app.connect('build-finished', make_carousel_thumbs) # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'sklearn', u'https://github.com/scikit-learn/' 'scikit-learn/blob/{revision}/' '{package}/{path}#L{lineno}')
# Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve("aslprep", "https://github.com/pennlinc/" "aslprep/blob/{revision}/" "{package}/{path}#L{lineno}") # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { "python": ("https://docs.python.org/", None), "numpy": ("http://docs.scipy.org/doc/numpy", None), "scipy": ("http://docs.scipy.org/doc/scipy/reference", None), "matplotlib": ("http://matplotlib.sourceforge.net", None), "bids": ("https://bids-standard.github.io/pybids/", None), "nibabel": ("https://nipy.org/nibabel/", None), "nipype": ("https://nipype.readthedocs.io/en/latest/", None), "niworkflows": ("https://www.nipreps.org/niworkflows/", None), "sdcflows": ("https://www.nipreps.org/sdcflows/", None), "smriprep": ("https://poldracklab.github.io/smriprep/", None), "templateflow": ("https://www.templateflow.org/python-client", None),
#man_show_urls = False # -- 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, 'PyKrige', 'PyKrige Documentation', author, 'PyKrige', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('pykrige', u'https://github.com/bsmurphy/' 'PyKrige/blob/{revision}/' '{package}/{path}#L{lineno}')
# Example configuration for intersphinx: refer to the Python standard library. # intersphinx configuration intersphinx_mapping = { 'python': ('https://docs.python.org/{.major}'.format(sys.version_info), None), 'numpy': ('https://docs.scipy.org/doc/numpy/', None), 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None), 'matplotlib': ('https://matplotlib.org/', None), 'sklearn': ('http://scikit-learn.org/stable', None) } # sphinx-gallery configuration sphinx_gallery_conf = { 'doc_module': 'sklearn_rvm', 'backreferences_dir': os.path.join('generated'), 'reference_url': { 'sklearn_rvm': None } } def setup(app): # a copy button to copy snippet of code from the documentation app.add_javascript('js/copybutton.js') # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'sklearn', 'https://github.com/Mind-the-Pineapple/' 'sklearn-rvm/blob/{revision}/' '{package}/{path}#L{lineno}')
] # -- 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, 'siqt', 'SiQt 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, 'SiQt', 'SiQt Documentation', author, 'SiQt', 'One line description of project.', 'Miscellaneous'), ] # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('SiQt', u'https://github.com/symerio/' 'SiQt/blob/{revision}/' '{package}/{path}#L{lineno}')
# Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve("fmriprep", "https://github.com/poldracklab/" "fmriprep/blob/{revision}/" "{package}/{path}#L{lineno}") # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { "python": ("https://docs.python.org/3/", None), "numpy": ("https://docs.scipy.org/doc/numpy", None), "scipy": ("https://docs.scipy.org/doc/scipy/reference", None), "matplotlib": ("https://matplotlib.org/", None), "bids": ("https://bids-standard.github.io/pybids/", None), "nibabel": ("https://nipy.org/nibabel/", None), "nipype": ("https://nipype.readthedocs.io/en/latest/", None), "niworkflows": ("https://www.nipreps.org/niworkflows/", None), "sdcflows": ("https://www.nipreps.org/sdcflows/", None), "smriprep": ("https://poldracklab.github.io/smriprep/", None), "templateflow": ("https://www.templateflow.org/python-client", None),
# Config for sphinx_issues issues_uri = 'https://github.com/scikit-cycling/scikit-cycling/issues/{issue}' issues_github_path = 'scikit-cycling/scikit-cycling' issues_user_uri = 'https://github.com/{user}' def setup(app): app.add_javascript('js/copybutton.js') # app.connect('autodoc-process-docstring', generate_example_rst) # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('skcycling', u'https://github.com/scikit-cycling/' 'scikit-cycling/blob/{revision}/' '{package}/{path}#L{lineno}')
examples_path = os.path.join(app.srcdir, "modules", "generated", "%s.examples" % name) if not os.path.exists(examples_path): # touch file open(examples_path, 'w').close() def setup(app): app.connect('autodoc-process-docstring', generate_example_rst) # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/': None} # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'copt', u'https://github.com/openopt/' 'copt/blob/{revision}/' '{package}/{path}#L{lineno}')
# Config for sphinx_issues issues_uri = 'https://github.com/scikit-learn-contrib/imbalanced-learn/issues/{issue}' issues_github_path = 'scikit-learn-contrib/imbalanced-learn' issues_user_uri = 'https://github.com/{user}' def setup(app): app.add_javascript('js/copybutton.js') # app.connect('autodoc-process-docstring', generate_example_rst) # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('imblearn', u'https://github.com/scikit-learn-contrib/' 'imbalanced-learn/blob/{revision}/' '{package}/{path}#L{lineno}')
issues_uri = 'https://github.com/scikit-learn-contrib/imbalanced-learn/issues/{issue}' issues_github_path = 'scikit-learn-contrib/imbalanced-learn' issues_user_uri = 'https://github.com/{user}' def setup(app): app.add_javascript('js/copybutton.js') app.connect('autodoc-process-docstring', generate_example_rst) # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/': None} # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('imblearn', u'https://github.com/scikit-learn-contrib/' 'imbalanced-learn/blob/{revision}/' '{package}/{path}#L{lineno}')
# Config for sphinx_issues issues_uri = 'https://github.com/pydicom/pydicom/issues/{issue}' issues_github_path = 'pydicom/pydicom' issues_user_uri = 'https://github.com/{user}' def setup(app): app.connect('autodoc-process-docstring', generate_example_rst) app.add_stylesheet('css/pydicom.css') # Example configuration for intersphinx: refer to # the Python standard library. # intersphinx_mapping = {'http://docs.python.org/': None} # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('pydicom', u'https://github.com/pydicom/' 'pydicom/blob/{revision}/' '{package}/{path}#L{lineno}') doctest_global_setup = """ import pydicom import os, os.path testfile_path = os.path.join(pydicom.__path__[0], '../tests/test_files') save_dir = os.getcwd() os.chdir(testfile_path) """
issues_uri = 'https://github.com/glemaitre/scikit-cycling/issues/{issue}' issues_github_path = 'glemaitre/scikit-cycling' issues_user_uri = 'https://github.com/{user}' def setup(app): app.connect('autodoc-process-docstring', generate_example_rst) # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/': None} # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'skcycling', u'https://github.com/glemaitre/' 'scikit-cycling/blob/{revision}/' '{package}/{path}#L{lineno}')
return print('Preparing carousel images') image_dir = os.path.join(app.builder.outdir, '_images') for glr_plot, max_width in carousel_thumbs.items(): image = os.path.join(image_dir, glr_plot) if os.path.exists(image): c_thumb = os.path.join(image_dir, glr_plot[:-4] + '_carousel.png') sphinx_gallery.gen_rst.scale_image(image, c_thumb, max_width, 190) # Config for sphinx_issues issues_uri = 'https://github.com/scikit-learn/scikit-learn/issues/{issue}' issues_github_path = 'scikit-learn/scikit-learn' issues_user_uri = 'https://github.com/{user}' def setup(app): # to hide/show the prompt in code examples: app.add_javascript('js/copybutton.js') app.add_javascript('js/extra.js') app.connect('build-finished', make_carousel_thumbs) # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve('sklearn', u'https://github.com/scikit-learn/' 'scikit-learn/blob/{revision}/' '{package}/{path}#L{lineno}')
# intersphinx configuration intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), } sphinx_gallery_conf = { 'doc_module': 'pulse2percept', 'backreferences_dir': '_api', 'reference_url': { 'pulse2percept': None }, 'examples_dirs': ['../examples'], 'gallery_dirs': ['examples'], 'remove_config_comments': True, 'subsection_order': ExplicitOrder([ '../examples/implants', '../examples/stimuli', '../examples/models', '../examples/developers' ]) } # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( 'pulse2percept', 'https://github.com/pulse2percept/' 'pulse2percept/blob/{revision}/' '{package}/{path}#L{lineno}')