diff --git a/Makefile b/Makefile index 9fb3896e..9bc4c259 100644 --- a/Makefile +++ b/Makefile @@ -33,6 +33,7 @@ clean-docs: ## remove documentation artifacts distclean: clean ## Restore to a clean checkout state rm -f .git/hooks/pre-commit + rm -f docs/notebooks/*.log hatch env prune test: init ## Run the tests (with coverage) diff --git a/pyproject.toml b/pyproject.toml index 4e8a9c1e..e22fe54d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -52,7 +52,6 @@ dev = [ "pytest-cov<=2.6.1", "pytest-xdist", "nbval==0.11.0", - "watermark~=2.4", "weylchamber>=0.3.2", "ipython", ] @@ -70,6 +69,7 @@ docs = [ "Jinja2==3.0.3", "docutils<=0.17", "matplotlib==3.7.5", + "watermark~=2.4", "zip-files==0.4.1", "ipython", ] @@ -103,6 +103,7 @@ cov-html = [ description = "Generate the docs (Python 3.8)" template = "docs" features = [ + "dev", "docs", ] python = "3.8" diff --git a/scripts/release.py b/scripts/release.py index 8d006584..36508ba1 100644 --- a/scripts/release.py +++ b/scripts/release.py @@ -67,7 +67,7 @@ def make_release(package_name, fast_test=False): 'README.md', join('docs', '09_examples.rst'), join('docs', 'index.rst'), - join('docs', 'overview.rst'), + join('docs', '01_overview.rst'), ] for filename in files_with_binder_links: set_binder_branch(filename, "v" + str(new_version)) @@ -92,7 +92,7 @@ def make_release(package_name, fast_test=False): files_with_released_binder_links = [ 'README.md', join('docs', 'index.rst'), - join('docs', 'overview.rst'), + join('docs', '01_overview.rst'), ] for filename in files_with_binder_links: if filename in files_with_released_binder_links: @@ -437,7 +437,7 @@ def make_notebooks(fast_test=False): def check_documentation(): """Verify the documentation (interactively).""" click.echo("Making the documentation....") - run(['make', 'docs-artifacts'], check=True, stdout=DEVNULL) + run(['make', 'docs'], check=True, stdout=DEVNULL) click.echo( "Check documentation in file://" + os.getcwd()