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/conf.py b/conf.py new file mode 100644 index 0000000..67379d9 --- /dev/null +++ b/conf.py @@ -0,0 +1,48 @@ +# -- 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", + "repository_branch": "main", + "use_repository_button": True, + "use_issues_button": True, + "use_edit_page_button": True, +} 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/conf.py b/docs/conf.py deleted file mode 100644 index 83dad2a..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,13 +0,0 @@ -extensions = ["myst_nb", "sphinx_copybutton"] - -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" diff --git a/docs/index.md b/index.md similarity index 100% rename from docs/index.md rename to index.md