From 689d57d7efe2ba5da0133e031ce026ade4156089 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Brigitta=20Sip=C5=91cz?= Date: Sun, 11 May 2025 16:28:52 -0700 Subject: [PATCH 1/2] MAINT: remove docs directory in favour of the main root --- .../images/open-with-jupytext-notebook.png | Bin docs/conf.py => conf.py | 0 docs/contributing.md => contributing.md | 0 docs/index.md => index.md | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename {docs/_static => _static}/images/open-with-jupytext-notebook.png (100%) rename docs/conf.py => conf.py (100%) rename docs/contributing.md => contributing.md (100%) rename docs/index.md => index.md (100%) diff --git a/docs/_static/images/open-with-jupytext-notebook.png b/_static/images/open-with-jupytext-notebook.png similarity index 100% rename from docs/_static/images/open-with-jupytext-notebook.png rename to _static/images/open-with-jupytext-notebook.png diff --git a/docs/conf.py b/conf.py similarity index 100% rename from docs/conf.py rename to conf.py diff --git a/docs/contributing.md b/contributing.md similarity index 100% rename from docs/contributing.md rename to contributing.md diff --git a/docs/index.md b/index.md similarity index 100% rename from docs/index.md rename to index.md From 4f69e6f8ef3537b98afd5183f694afa75480a274 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Brigitta=20Sip=C5=91cz?= Date: Sun, 11 May 2025 17:18:41 -0700 Subject: [PATCH 2/2] MAINT: extending configuration --- conf.py | 41 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/conf.py b/conf.py index 83dad2a..67379d9 100644 --- a/conf.py +++ b/conf.py @@ -1,13 +1,48 @@ -extensions = ["myst_nb", "sphinx_copybutton"] +# -- Project information ----------------------------------------------------- +project = 'Scientific Python Executable Tutorials' +copyright = '2025, Scientific Python developers' +author = 'Scientific Python developers' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. + +extensions = [ + "myst_nb", + "sphinx_copybutton", +] + +myst_enable_extensions = [ + 'dollarmath', +] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'notes', '.tox', '.tmp', '.pytest_cache', 'README.md'] + +# MyST-NB configuration +nb_merge_streams = True +nb_execution_mode = "cache" + +nb_execution_excludepatterns = [] + + +# -- 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 = 'sphinx_book_theme' html_title = 'Executable Tutorials' html_theme_options = { "repository_url": "https://github.com/scientific-python/executable-tutorials", - "path_to_docs": "docs", "repository_branch": "main", "use_repository_button": True, "use_issues_button": True, "use_edit_page_button": True, } -nb_execution_mode = "auto"