fix

scikit-hep · Jul 31, 2024 · 1c95ef0 · 1c95ef0
1 parent 57a272e
commit 1c95ef0
Show file tree

Hide file tree

Showing 64 changed files with 7 additions and 7 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -33,7 +33,7 @@ jobs:
         python-version: "3.11"
     - run: sudo apt-get install pandoc
     - uses: yezz123/setup-uv@v4
-    - run: nox -s docs
+    - run: nox -s doc
     - uses: actions/upload-pages-artifact@v3
       with:
         path: './build/html'

diff --git a/.gitignore b/.gitignore
@@ -54,7 +54,7 @@ coverage.xml
 
 tests/fig/*.svg
 
-docs/index.rst
+doc/index.rst
 
 testcase
 

diff --git a/docs/_static/bench.svg → doc/_static/bench.svg b/docs/_static/bench.svg → doc/_static/bench.svg
diff --git a/docs/_static/bench2d.svg → doc/_static/bench2d.svg b/docs/_static/bench2d.svg → doc/_static/bench2d.svg
diff --git a/docs/_static/demo_output.png → doc/_static/demo_output.png b/docs/_static/demo_output.png → doc/_static/demo_output.png
diff --git a/docs/_static/iminuit_logo.svg → doc/_static/iminuit_logo.svg b/docs/_static/iminuit_logo.svg → doc/_static/iminuit_logo.svg
diff --git a/docs/_static/interactive_demo.gif → doc/_static/interactive_demo.gif b/docs/_static/interactive_demo.gif → doc/_static/interactive_demo.gif
diff --git a/docs/_static/interactive_demo.ipynb → doc/_static/interactive_demo.ipynb b/docs/_static/interactive_demo.ipynb → doc/_static/interactive_demo.ipynb
diff --git a/docs/_static/minuit_jupyter.png → doc/_static/minuit_jupyter.png b/docs/_static/minuit_jupyter.png → doc/_static/minuit_jupyter.png
diff --git a/docs/_static/mov2gif.sh → doc/_static/mov2gif.sh b/docs/_static/mov2gif.sh → doc/_static/mov2gif.sh
diff --git a/docs/_static/numba_vs_scipy.svg → doc/_static/numba_vs_scipy.svg b/docs/_static/numba_vs_scipy.svg → doc/_static/numba_vs_scipy.svg
diff --git a/docs/_static/overhead.svg → doc/_static/overhead.svg b/docs/_static/overhead.svg → doc/_static/overhead.svg
diff --git a/docs/_static/roofit_vs_iminuit+numba.svg → doc/_static/roofit_vs_iminuit+numba.svg b/docs/_static/roofit_vs_iminuit+numba.svg → doc/_static/roofit_vs_iminuit+numba.svg
diff --git a/docs/about.rst → doc/about.rst b/docs/about.rst → doc/about.rst
diff --git a/docs/benchmark.rst → doc/benchmark.rst b/docs/benchmark.rst → doc/benchmark.rst
diff --git a/docs/bibliography.txt → doc/bibliography.txt b/docs/bibliography.txt → doc/bibliography.txt
diff --git a/docs/changelog.rst → doc/changelog.rst b/docs/changelog.rst → doc/changelog.rst
diff --git a/docs/citation.rst → doc/citation.rst b/docs/citation.rst → doc/citation.rst
diff --git a/docs/conf.py → doc/conf.py b/docs/conf.py → doc/conf.py
diff --git a/docs/contribute.rst → doc/contribute.rst b/docs/contribute.rst → doc/contribute.rst
diff --git a/docs/faq.rst → doc/faq.rst b/docs/faq.rst → doc/faq.rst
diff --git a/docs/index.rst → doc/index.rst b/docs/index.rst → doc/index.rst
diff --git a/docs/index.rst.in → doc/index.rst.in b/docs/index.rst.in → doc/index.rst.in
diff --git a/docs/install.rst → doc/install.rst b/docs/install.rst → doc/install.rst
diff --git a/docs/mnusersguide.pdf → doc/mnusersguide.pdf b/docs/mnusersguide.pdf → doc/mnusersguide.pdf
diff --git a/...notebooks/automatic_differentiation.ipynb → ...notebooks/automatic_differentiation.ipynb b/...notebooks/automatic_differentiation.ipynb → ...notebooks/automatic_differentiation.ipynb
diff --git a/docs/notebooks/basic.ipynb → doc/notebooks/basic.ipynb b/docs/notebooks/basic.ipynb → doc/notebooks/basic.ipynb
diff --git a/docs/notebooks/binned_vs_unbinned.ipynb → doc/notebooks/binned_vs_unbinned.ipynb b/docs/notebooks/binned_vs_unbinned.ipynb → doc/notebooks/binned_vs_unbinned.ipynb
diff --git a/docs/notebooks/conditional_variable.ipynb → doc/notebooks/conditional_variable.ipynb b/docs/notebooks/conditional_variable.ipynb → doc/notebooks/conditional_variable.ipynb
diff --git a/docs/notebooks/correlated_data.ipynb → doc/notebooks/correlated_data.ipynb b/docs/notebooks/correlated_data.ipynb → doc/notebooks/correlated_data.ipynb
diff --git a/.../notebooks/cost_function_benchmarks.ipynb → doc/notebooks/cost_function_benchmarks.ipynb b/.../notebooks/cost_function_benchmarks.ipynb → doc/notebooks/cost_function_benchmarks.ipynb
diff --git a/docs/notebooks/cost_functions.ipynb → doc/notebooks/cost_functions.ipynb b/docs/notebooks/cost_functions.ipynb → doc/notebooks/cost_functions.ipynb
diff --git a/docs/notebooks/cython.ipynb → doc/notebooks/cython.ipynb b/docs/notebooks/cython.ipynb → doc/notebooks/cython.ipynb
diff --git a/docs/notebooks/error_bands.ipynb → doc/notebooks/error_bands.ipynb b/docs/notebooks/error_bands.ipynb → doc/notebooks/error_bands.ipynb
diff --git a/docs/notebooks/external_minimizer.ipynb → doc/notebooks/external_minimizer.ipynb b/docs/notebooks/external_minimizer.ipynb → doc/notebooks/external_minimizer.ipynb
diff --git a/docs/notebooks/generic_least_squares.ipynb → doc/notebooks/generic_least_squares.ipynb b/docs/notebooks/generic_least_squares.ipynb → doc/notebooks/generic_least_squares.ipynb
diff --git a/docs/notebooks/gof.ipynb → doc/notebooks/gof.ipynb b/docs/notebooks/gof.ipynb → doc/notebooks/gof.ipynb
diff --git a/docs/notebooks/hesse_and_minos.ipynb → doc/notebooks/hesse_and_minos.ipynb b/docs/notebooks/hesse_and_minos.ipynb → doc/notebooks/hesse_and_minos.ipynb
diff --git a/docs/notebooks/interactive.ipynb → doc/notebooks/interactive.ipynb b/docs/notebooks/interactive.ipynb → doc/notebooks/interactive.ipynb
diff --git a/docs/notebooks/memory_layout.ipynb → doc/notebooks/memory_layout.ipynb b/docs/notebooks/memory_layout.ipynb → doc/notebooks/memory_layout.ipynb
diff --git a/docs/notebooks/numba.ipynb → doc/notebooks/numba.ipynb b/docs/notebooks/numba.ipynb → doc/notebooks/numba.ipynb
diff --git a/docs/notebooks/roofit.ipynb → doc/notebooks/roofit.ipynb b/docs/notebooks/roofit.ipynb → doc/notebooks/roofit.ipynb
diff --git a/docs/notebooks/roofit/rf101_basics.ipynb → doc/notebooks/roofit/rf101_basics.ipynb b/docs/notebooks/roofit/rf101_basics.ipynb → doc/notebooks/roofit/rf101_basics.ipynb
diff --git a/...otebooks/roofit/rf109_chi2residpull.ipynb → ...otebooks/roofit/rf109_chi2residpull.ipynb b/...otebooks/roofit/rf109_chi2residpull.ipynb → ...otebooks/roofit/rf109_chi2residpull.ipynb
diff --git a/docs/notebooks/scipy_and_constraints.ipynb → doc/notebooks/scipy_and_constraints.ipynb b/docs/notebooks/scipy_and_constraints.ipynb → doc/notebooks/scipy_and_constraints.ipynb
diff --git a/docs/notebooks/simultaneous_fits.ipynb → doc/notebooks/simultaneous_fits.ipynb b/docs/notebooks/simultaneous_fits.ipynb → doc/notebooks/simultaneous_fits.ipynb
diff --git a/docs/notebooks/template_fits.ipynb → doc/notebooks/template_fits.ipynb b/docs/notebooks/template_fits.ipynb → doc/notebooks/template_fits.ipynb
diff --git a/docs/notebooks/template_gof.ipynb → doc/notebooks/template_gof.ipynb b/docs/notebooks/template_gof.ipynb → doc/notebooks/template_gof.ipynb
diff --git a/docs/notebooks/template_model_mix.ipynb → doc/notebooks/template_model_mix.ipynb b/docs/notebooks/template_model_mix.ipynb → doc/notebooks/template_model_mix.ipynb
diff --git a/docs/notebooks/unstable_fit.ipynb → doc/notebooks/unstable_fit.ipynb b/docs/notebooks/unstable_fit.ipynb → doc/notebooks/unstable_fit.ipynb
diff --git a/docs/plots/bench.py → doc/plots/bench.py b/docs/plots/bench.py → doc/plots/bench.py
diff --git a/docs/plots/interactive.py → doc/plots/interactive.py b/docs/plots/interactive.py → doc/plots/interactive.py
diff --git a/docs/plots/loss.py → doc/plots/loss.py b/docs/plots/loss.py → doc/plots/loss.py
diff --git a/docs/plots/mncontour.py → doc/plots/mncontour.py b/docs/plots/mncontour.py → doc/plots/mncontour.py
diff --git a/docs/plots/mnmatrix.py → doc/plots/mnmatrix.py b/docs/plots/mnmatrix.py → doc/plots/mnmatrix.py
diff --git a/docs/plots/mnprofile.py → doc/plots/mnprofile.py b/docs/plots/mnprofile.py → doc/plots/mnprofile.py
diff --git a/docs/reference.rst → doc/reference.rst b/docs/reference.rst → doc/reference.rst
diff --git a/docs/release.md → doc/release.md b/docs/release.md → doc/release.md
diff --git a/docs/root_version.py → doc/root_version.py b/docs/root_version.py → doc/root_version.py
diff --git a/docs/studies.rst → doc/studies.rst b/docs/studies.rst → doc/studies.rst
diff --git a/docs/tutorials.rst → doc/tutorials.rst b/docs/tutorials.rst → doc/tutorials.rst
diff --git a/docs/update_changelog.py → doc/update_changelog.py b/docs/update_changelog.py → doc/update_changelog.py
diff --git a/noxfile.py b/noxfile.py
@@ -50,17 +50,17 @@ def coverage(session: nox.Session) -> None:
 
 # 3.11 needed by Cython notebook
 @nox.session(python="3.11", reuse_venv=True)
-def docs(session: nox.Session) -> None:
+def doc(session: nox.Session) -> None:
     """Build html documentation."""
-    session.install("-e.[test,docs]")
+    session.install("-e.[test,doc]")
 
     # link check
     session.run(
         "sphinx-build",
         "-n",  # nitpicky mode
         "-T",  # full tracebacks
         "-b=html",
-        "docs",
+        "doc",
         "build/html",
     )
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -65,7 +65,7 @@ test = [
     "pydantic",
     "annotated_types",
 ]
-docs = [
+doc = [
     "sphinx-rtd-theme", # installs correct sphinx as well
     "nbsphinx",
     "nbconvert",
@@ -108,7 +108,7 @@ lint.pydocstyle.convention = "numpy"
 "test_*.py" = ["B", "D"]
 ".ci/*.py" = ["D"]
 "bench/*.py" = ["D"]
-"docs/*.py" = ["D"]
+"doc/*.py" = ["D"]
 
 [tool.mypy]
 ignore_missing_imports = true