diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c5786f3a..3f398911 100644 --- 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 index 38b8d6b0..8229cb75 100644 --- 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 b/doc/_static/bench.svg similarity index 100% rename from docs/_static/bench.svg rename to doc/_static/bench.svg diff --git a/docs/_static/bench2d.svg b/doc/_static/bench2d.svg similarity index 100% rename from docs/_static/bench2d.svg rename to doc/_static/bench2d.svg diff --git a/docs/_static/demo_output.png b/doc/_static/demo_output.png similarity index 100% rename from docs/_static/demo_output.png rename to doc/_static/demo_output.png diff --git a/docs/_static/iminuit_logo.svg b/doc/_static/iminuit_logo.svg similarity index 100% rename from docs/_static/iminuit_logo.svg rename to doc/_static/iminuit_logo.svg diff --git a/docs/_static/interactive_demo.gif b/doc/_static/interactive_demo.gif similarity index 100% rename from docs/_static/interactive_demo.gif rename to doc/_static/interactive_demo.gif diff --git a/docs/_static/interactive_demo.ipynb b/doc/_static/interactive_demo.ipynb similarity index 100% rename from docs/_static/interactive_demo.ipynb rename to doc/_static/interactive_demo.ipynb diff --git a/docs/_static/minuit_jupyter.png b/doc/_static/minuit_jupyter.png similarity index 100% rename from docs/_static/minuit_jupyter.png rename to doc/_static/minuit_jupyter.png diff --git a/docs/_static/mov2gif.sh b/doc/_static/mov2gif.sh similarity index 100% rename from docs/_static/mov2gif.sh rename to doc/_static/mov2gif.sh diff --git a/docs/_static/numba_vs_scipy.svg b/doc/_static/numba_vs_scipy.svg similarity index 100% rename from docs/_static/numba_vs_scipy.svg rename to doc/_static/numba_vs_scipy.svg diff --git a/docs/_static/overhead.svg b/doc/_static/overhead.svg similarity index 100% rename from docs/_static/overhead.svg rename to doc/_static/overhead.svg diff --git a/docs/_static/roofit_vs_iminuit+numba.svg b/doc/_static/roofit_vs_iminuit+numba.svg similarity index 100% rename from docs/_static/roofit_vs_iminuit+numba.svg rename to doc/_static/roofit_vs_iminuit+numba.svg diff --git a/docs/about.rst b/doc/about.rst similarity index 100% rename from docs/about.rst rename to doc/about.rst diff --git a/docs/benchmark.rst b/doc/benchmark.rst similarity index 100% rename from docs/benchmark.rst rename to doc/benchmark.rst diff --git a/docs/bibliography.txt b/doc/bibliography.txt similarity index 100% rename from docs/bibliography.txt rename to doc/bibliography.txt diff --git a/docs/changelog.rst b/doc/changelog.rst similarity index 100% rename from docs/changelog.rst rename to doc/changelog.rst diff --git a/docs/citation.rst b/doc/citation.rst similarity index 100% rename from docs/citation.rst rename to doc/citation.rst diff --git a/docs/conf.py b/doc/conf.py similarity index 100% rename from docs/conf.py rename to doc/conf.py diff --git a/docs/contribute.rst b/doc/contribute.rst similarity index 100% rename from docs/contribute.rst rename to doc/contribute.rst diff --git a/docs/faq.rst b/doc/faq.rst similarity index 100% rename from docs/faq.rst rename to doc/faq.rst diff --git a/docs/index.rst b/doc/index.rst similarity index 100% rename from docs/index.rst rename to doc/index.rst diff --git a/docs/index.rst.in b/doc/index.rst.in similarity index 100% rename from docs/index.rst.in rename to doc/index.rst.in diff --git a/docs/install.rst b/doc/install.rst similarity index 100% rename from docs/install.rst rename to doc/install.rst diff --git a/docs/mnusersguide.pdf b/doc/mnusersguide.pdf similarity index 100% rename from docs/mnusersguide.pdf rename to doc/mnusersguide.pdf diff --git a/docs/notebooks/automatic_differentiation.ipynb b/doc/notebooks/automatic_differentiation.ipynb similarity index 100% rename from docs/notebooks/automatic_differentiation.ipynb rename to doc/notebooks/automatic_differentiation.ipynb diff --git a/docs/notebooks/basic.ipynb b/doc/notebooks/basic.ipynb similarity index 100% rename from docs/notebooks/basic.ipynb rename to doc/notebooks/basic.ipynb diff --git a/docs/notebooks/binned_vs_unbinned.ipynb b/doc/notebooks/binned_vs_unbinned.ipynb similarity index 100% rename from docs/notebooks/binned_vs_unbinned.ipynb rename to doc/notebooks/binned_vs_unbinned.ipynb diff --git a/docs/notebooks/conditional_variable.ipynb b/doc/notebooks/conditional_variable.ipynb similarity index 100% rename from docs/notebooks/conditional_variable.ipynb rename to doc/notebooks/conditional_variable.ipynb diff --git a/docs/notebooks/correlated_data.ipynb b/doc/notebooks/correlated_data.ipynb similarity index 100% rename from docs/notebooks/correlated_data.ipynb rename to doc/notebooks/correlated_data.ipynb diff --git a/docs/notebooks/cost_function_benchmarks.ipynb b/doc/notebooks/cost_function_benchmarks.ipynb similarity index 100% rename from docs/notebooks/cost_function_benchmarks.ipynb rename to doc/notebooks/cost_function_benchmarks.ipynb diff --git a/docs/notebooks/cost_functions.ipynb b/doc/notebooks/cost_functions.ipynb similarity index 100% rename from docs/notebooks/cost_functions.ipynb rename to doc/notebooks/cost_functions.ipynb diff --git a/docs/notebooks/cython.ipynb b/doc/notebooks/cython.ipynb similarity index 100% rename from docs/notebooks/cython.ipynb rename to doc/notebooks/cython.ipynb diff --git a/docs/notebooks/error_bands.ipynb b/doc/notebooks/error_bands.ipynb similarity index 100% rename from docs/notebooks/error_bands.ipynb rename to doc/notebooks/error_bands.ipynb diff --git a/docs/notebooks/external_minimizer.ipynb b/doc/notebooks/external_minimizer.ipynb similarity index 100% rename from docs/notebooks/external_minimizer.ipynb rename to doc/notebooks/external_minimizer.ipynb diff --git a/docs/notebooks/generic_least_squares.ipynb b/doc/notebooks/generic_least_squares.ipynb similarity index 100% rename from docs/notebooks/generic_least_squares.ipynb rename to doc/notebooks/generic_least_squares.ipynb diff --git a/docs/notebooks/gof.ipynb b/doc/notebooks/gof.ipynb similarity index 100% rename from docs/notebooks/gof.ipynb rename to doc/notebooks/gof.ipynb diff --git a/docs/notebooks/hesse_and_minos.ipynb b/doc/notebooks/hesse_and_minos.ipynb similarity index 100% rename from docs/notebooks/hesse_and_minos.ipynb rename to doc/notebooks/hesse_and_minos.ipynb diff --git a/docs/notebooks/interactive.ipynb b/doc/notebooks/interactive.ipynb similarity index 100% rename from docs/notebooks/interactive.ipynb rename to doc/notebooks/interactive.ipynb diff --git a/docs/notebooks/memory_layout.ipynb b/doc/notebooks/memory_layout.ipynb similarity index 100% rename from docs/notebooks/memory_layout.ipynb rename to doc/notebooks/memory_layout.ipynb diff --git a/docs/notebooks/numba.ipynb b/doc/notebooks/numba.ipynb similarity index 100% rename from docs/notebooks/numba.ipynb rename to doc/notebooks/numba.ipynb diff --git a/docs/notebooks/roofit.ipynb b/doc/notebooks/roofit.ipynb similarity index 100% rename from docs/notebooks/roofit.ipynb rename to doc/notebooks/roofit.ipynb diff --git a/docs/notebooks/roofit/rf101_basics.ipynb b/doc/notebooks/roofit/rf101_basics.ipynb similarity index 100% rename from docs/notebooks/roofit/rf101_basics.ipynb rename to doc/notebooks/roofit/rf101_basics.ipynb diff --git a/docs/notebooks/roofit/rf109_chi2residpull.ipynb b/doc/notebooks/roofit/rf109_chi2residpull.ipynb similarity index 100% rename from docs/notebooks/roofit/rf109_chi2residpull.ipynb rename to doc/notebooks/roofit/rf109_chi2residpull.ipynb diff --git a/docs/notebooks/scipy_and_constraints.ipynb b/doc/notebooks/scipy_and_constraints.ipynb similarity index 100% rename from docs/notebooks/scipy_and_constraints.ipynb rename to doc/notebooks/scipy_and_constraints.ipynb diff --git a/docs/notebooks/simultaneous_fits.ipynb b/doc/notebooks/simultaneous_fits.ipynb similarity index 100% rename from docs/notebooks/simultaneous_fits.ipynb rename to doc/notebooks/simultaneous_fits.ipynb diff --git a/docs/notebooks/template_fits.ipynb b/doc/notebooks/template_fits.ipynb similarity index 100% rename from docs/notebooks/template_fits.ipynb rename to doc/notebooks/template_fits.ipynb diff --git a/docs/notebooks/template_gof.ipynb b/doc/notebooks/template_gof.ipynb similarity index 100% rename from docs/notebooks/template_gof.ipynb rename to doc/notebooks/template_gof.ipynb diff --git a/docs/notebooks/template_model_mix.ipynb b/doc/notebooks/template_model_mix.ipynb similarity index 100% rename from docs/notebooks/template_model_mix.ipynb rename to doc/notebooks/template_model_mix.ipynb diff --git a/docs/notebooks/unstable_fit.ipynb b/doc/notebooks/unstable_fit.ipynb similarity index 100% rename from docs/notebooks/unstable_fit.ipynb rename to doc/notebooks/unstable_fit.ipynb diff --git a/docs/plots/bench.py b/doc/plots/bench.py similarity index 100% rename from docs/plots/bench.py rename to doc/plots/bench.py diff --git a/docs/plots/interactive.py b/doc/plots/interactive.py similarity index 100% rename from docs/plots/interactive.py rename to doc/plots/interactive.py diff --git a/docs/plots/loss.py b/doc/plots/loss.py similarity index 100% rename from docs/plots/loss.py rename to doc/plots/loss.py diff --git a/docs/plots/mncontour.py b/doc/plots/mncontour.py similarity index 100% rename from docs/plots/mncontour.py rename to doc/plots/mncontour.py diff --git a/docs/plots/mnmatrix.py b/doc/plots/mnmatrix.py similarity index 100% rename from docs/plots/mnmatrix.py rename to doc/plots/mnmatrix.py diff --git a/docs/plots/mnprofile.py b/doc/plots/mnprofile.py similarity index 100% rename from docs/plots/mnprofile.py rename to doc/plots/mnprofile.py diff --git a/docs/reference.rst b/doc/reference.rst similarity index 100% rename from docs/reference.rst rename to doc/reference.rst diff --git a/docs/release.md b/doc/release.md similarity index 100% rename from docs/release.md rename to doc/release.md diff --git a/docs/root_version.py b/doc/root_version.py similarity index 100% rename from docs/root_version.py rename to doc/root_version.py diff --git a/docs/studies.rst b/doc/studies.rst similarity index 100% rename from docs/studies.rst rename to doc/studies.rst diff --git a/docs/tutorials.rst b/doc/tutorials.rst similarity index 100% rename from docs/tutorials.rst rename to doc/tutorials.rst diff --git a/docs/update_changelog.py b/doc/update_changelog.py similarity index 100% rename from docs/update_changelog.py rename to doc/update_changelog.py diff --git a/noxfile.py b/noxfile.py index e3168633..5b87956c 100644 --- a/noxfile.py +++ b/noxfile.py @@ -50,9 +50,9 @@ 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( @@ -60,7 +60,7 @@ def docs(session: nox.Session) -> None: "-n", # nitpicky mode "-T", # full tracebacks "-b=html", - "docs", + "doc", "build/html", ) diff --git a/pyproject.toml b/pyproject.toml index fe6989a2..17232796 100644 --- 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