From 8a3dcac1a36657a8f22a3d1ed160621aaa6e69f8 Mon Sep 17 00:00:00 2001 From: Ziga Luksic Date: Tue, 22 Aug 2023 15:42:21 +0200 Subject: [PATCH] fix versions and remove clutter --- docs/environment.yml | 4 +- docs/source/conf.py | 104 ++----------------------------------------- pyproject.toml | 4 +- 3 files changed, 7 insertions(+), 105 deletions(-) diff --git a/docs/environment.yml b/docs/environment.yml index d7e3451e..abe79b0c 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -6,8 +6,8 @@ dependencies: - pip - python=3.10 - pip: - - Sphinx - - sphinx_rtd_theme + - Sphinx==7.1.2 + - sphinx_rtd_theme==1.3.0 - nbsphinx - jupyter - sphinx_mdinclude diff --git a/docs/source/conf.py b/docs/source/conf.py index 99021a7c..bd53c162 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,12 +6,6 @@ # full list see the documentation: # http://www.sphinx-doc.org/en/master/config -# -- Path setup -------------------------------------------------------------- - -# 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. -# import os import shutil import sys @@ -52,13 +46,6 @@ # -- General configuration --------------------------------------------------- -# If your documentation needs a minimal Sphinx version, state it here. -# -# 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.doctest", @@ -89,18 +76,12 @@ # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] source_suffix = ".rst" # The master toctree document. master_doc = "index" -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. +# The language for content autogenerated by Sphinx. language = "en" # List of patterns, relative to source directory, that match files and @@ -111,9 +92,6 @@ # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - # Mock imports that won't and don't have to be installed in ReadTheDocs environment autodoc_mock_imports = [ "ray", @@ -121,6 +99,7 @@ "hvplot", "pyepsg", "xarray", + "tdigest", ] # -- Options for HTML output ------------------------------------------------- @@ -132,27 +111,11 @@ html_logo = "./figures/eo-learn-logo-white.png" -# 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 --------------------------------------------- @@ -161,67 +124,6 @@ # show/hide links for source html_show_sourcelink = False -# -- 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': '', - # Latex figure (float) alignment - # - # '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, "eo-learn.tex", doc_title, author, "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, "eo-learn", doc_title, [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, "eo-learn", doc_title, author, "eo-learn", "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"] - # -- Custom settings ---------------------------------------------- @@ -255,7 +157,7 @@ def copy_documentation_examples(source_folder, target_folder): shutil.copyfile(source_path, target_path) -# copy examples +# Copy examples shutil.rmtree(EXAMPLES_FOLDER, ignore_errors=True) copy_documentation_examples("../../examples", EXAMPLES_FOLDER) diff --git a/pyproject.toml b/pyproject.toml index 8b1f823d..eff21354 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -88,9 +88,9 @@ docs = [ "eo-learn[ALL]", "jupyter", "nbsphinx", - "sphinx", + "sphinx==7.1.2", "sphinx_mdinclude", - "sphinx_rtd_theme", + "sphinx_rtd_theme==1.3.0", ] dev = [ "build",