diff --git a/.readthedocs.yml b/.readthedocs.yml index 7039bd8..869ad52 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,9 +1,9 @@ version: 2 build: - os: "ubuntu-22.04" + os: ubuntu-22.04 tools: - python: "3.11" + python: 3.11 python: install: diff --git a/docs/source/conf.py b/docs/source/conf.py index 6749e81..093bc76 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -38,38 +38,32 @@ "colon_fence", ] -html_static_path = ["_static"] -html_css_files = ["styles.css"] + html_theme = "sphinx_book_theme" html_favicon = "favicon.ico" html_logo = "logo.png" html_title = "Scarf documentation" html_theme_options = { "repository_url": "https://github.com/parashardhapola/scarf", - "use_repository_button": True, - "use_issues_button": False, - "use_edit_page_button": False, + "home_page_in_toc": True, "path_to_docs": "docs/source", + "show_navbar_depth": 2, + "use_repository_button": True, "use_download_button": True, "use_fullscreen_button": True, - "home_page_in_toc": True, - "show_navbar_depth": 2, + "navigation_with_keys": False, "toc_title": "Sections", } +html_static_path = ["_static"] +html_css_files = ["styles.css"] + htmlhelp_basename = "Scarf Documentation" -html_sidebars = { - "**": [ - "globaltoc.html", - "searchbox.html", - ], - 'using/windows': ['windows-sidebar.html', 'searchbox.html'], -} man_pages = [(master_doc, "scarf", "Scarf Documentation", [author], 1)] nb_execution_allow_errors = True nb_execution_mode = "auto" -nb_execution_timeout = 5000 +nb_execution_timeout = 200 import matplotlib diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt index 6e14b49..29715d8 100644 --- a/docs/source/requirements.txt +++ b/docs/source/requirements.txt @@ -9,4 +9,4 @@ sphinx-copybutton sphinx-external-toc sphinx-tabs topacedo -nbclient +nbclient<=0.8