improve python intro and scala web docs

com-lihaoyi · Feb 1, 2025 · 3ad0947 · 3ad0947
1 parent 35b24b1
commit 3ad0947
Show file tree

Hide file tree

Showing 41 changed files with 21 additions and 11 deletions.
diff --git a/docs/modules/ROOT/pages/pythonlib/intro.adoc b/docs/modules/ROOT/pages/pythonlib/intro.adoc
@@ -2,11 +2,18 @@
 = Building Python with Mill
 
 
-
-
 :language: python
 :language-small: python
 
+Mill can be used to build Python projects, whether large pure-Python codebases
+or Python modules mixed in with other languages like Java or Kotlin. While Python
+is traditionally a scripting language, larger Python projects often include tools like
+xref:pythonlib/linting.adoc#_formatting[autoformatting], xref:pythonlib/linting.adoc#_linting[linting],
+typechecking with Mypy, packaging PEX files, xref:pythonlib/publishing.adoc[publishing to PyPI],
+and so on. These workflows can benefit from a build tool like Mill to provide parallelization,
+caching, xref:large/selective-execution.adoc[Selective Test Execution], and other
+features that speed up development and CI.
+
 include::partial$Intro_Header.adoc[]
 
 NOTE: Mill's Python support is still under active development, and you can expect

diff --git a/docs/modules/ROOT/pages/scalalib/web-examples.adoc b/docs/modules/ROOT/pages/scalalib/web-examples.adoc
@@ -17,30 +17,32 @@ include::partial$example/scalalib/web/1-todo-webapp.adoc[]
 
 include::partial$example/scalalib/web/2-webapp-cache-busting.adoc[]
 
+== TodoMVC http4s Web App
+
+include::partial$example/scalalib/web/3-todo-http4s.adoc[]
+
 == Scala.js Modules
 
-include::partial$example/scalalib/web/3-scalajs-module.adoc[]
+include::partial$example/scalalib/web/4-scalajs-module.adoc[]
 
 == Scala.js Webserver Integration
 
-include::partial$example/scalalib/web/4-webapp-scalajs.adoc[]
+include::partial$example/scalalib/web/5-webapp-scalajs.adoc[]
 
 == Scala.js/Scala-JVM Code Sharing
 
-include::partial$example/scalalib/web/5-webapp-scalajs-shared.adoc[]
+include::partial$example/scalalib/web/6-webapp-scalajs-shared.adoc[]
 
 == Publishing Cross-Platform Scala Modules
 
-include::partial$example/scalalib/web/6-cross-version-platform-publishing.adoc[]
+include::partial$example/scalalib/web/7-cross-version-platform-publishing.adoc[]
 
 == Publishing Cross-Platform Scala Modules Alternative
 
-include::partial$example/scalalib/web/7-cross-platform-version-publishing.adoc[]
+include::partial$example/scalalib/web/8-cross-platform-version-publishing.adoc[]
 
 == Scala.js WebAssembly Example
 
-include::partial$example/scalalib/web/8-wasm.adoc[]
+include::partial$example/scalalib/web/9-wasm.adoc[]
 
-== TodoMVC http4s Web App
 
-include::partial$example/scalalib/web/9-todo-http4s.adoc[]
diff --git a/...ple/scalalib/web/9-todo-http4s/build.mill → ...ple/scalalib/web/3-todo-http4s/build.mill b/...ple/scalalib/web/9-todo-http4s/build.mill → ...ple/scalalib/web/3-todo-http4s/build.mill
@@ -21,7 +21,8 @@ object `package` extends RootModule with ScalaModule {
   }
 }
 
-// This example demonstrates how to set up a simple Scala webserver
+// This example demonstrates how to set up a Scala webserver using the popular
+// https://http4s.org/[Http4S] web framework and associated libraries.
 // implementing the popular Todo-MVC demo application. It includes a test suite
 // that spins up the web server locally and makes HTTP requests against it.
 

diff --git a/...webapp-scalajs/resources/webapp/index.css → .../3-todo-http4s/resources/webapp/index.css b/...webapp-scalajs/resources/webapp/index.css → .../3-todo-http4s/resources/webapp/index.css
diff --git a/...eb/9-todo-http4s/resources/webapp/main.js → ...eb/3-todo-http4s/resources/webapp/main.js b/...eb/9-todo-http4s/resources/webapp/main.js → ...eb/3-todo-http4s/resources/webapp/main.js
diff --git a/...alalib/web/9-todo-http4s/src/WebApp.scala → ...alalib/web/3-todo-http4s/src/WebApp.scala b/...alalib/web/9-todo-http4s/src/WebApp.scala → ...alalib/web/3-todo-http4s/src/WebApp.scala
diff --git a/.../9-todo-http4s/test/src/WebAppTests.scala → .../3-todo-http4s/test/src/WebAppTests.scala b/.../9-todo-http4s/test/src/WebAppTests.scala → .../3-todo-http4s/test/src/WebAppTests.scala
diff --git a/.../scalalib/web/3-scalajs-module/build.mill → .../scalalib/web/4-scalajs-module/build.mill b/.../scalalib/web/3-scalajs-module/build.mill → .../scalalib/web/4-scalajs-module/build.mill
diff --git a/...ib/web/3-scalajs-module/foo/src/Foo.scala → ...ib/web/4-scalajs-module/foo/src/Foo.scala b/...ib/web/3-scalajs-module/foo/src/Foo.scala → ...ib/web/4-scalajs-module/foo/src/Foo.scala
diff --git a/...calajs-module/foo/test/src/FooTests.scala → ...calajs-module/foo/test/src/FooTests.scala b/...calajs-module/foo/test/src/FooTests.scala → ...calajs-module/foo/test/src/FooTests.scala
diff --git a/.../scalalib/web/4-webapp-scalajs/build.mill → .../scalalib/web/5-webapp-scalajs/build.mill b/.../scalalib/web/4-webapp-scalajs/build.mill → .../scalalib/web/5-webapp-scalajs/build.mill
diff --git a/...webapp-scalajs/client/src/ClientApp.scala → ...webapp-scalajs/client/src/ClientApp.scala b/...webapp-scalajs/client/src/ClientApp.scala → ...webapp-scalajs/client/src/ClientApp.scala
diff --git a/...scalajs-shared/resources/webapp/index.css → ...webapp-scalajs/resources/webapp/index.css b/...scalajs-shared/resources/webapp/index.css → ...webapp-scalajs/resources/webapp/index.css
diff --git a/...lib/web/4-webapp-scalajs/src/WebApp.scala → ...lib/web/5-webapp-scalajs/src/WebApp.scala b/...lib/web/4-webapp-scalajs/src/WebApp.scala → ...lib/web/5-webapp-scalajs/src/WebApp.scala
diff --git a/...webapp-scalajs/test/src/WebAppTests.scala → ...webapp-scalajs/test/src/WebAppTests.scala b/...webapp-scalajs/test/src/WebAppTests.scala → ...webapp-scalajs/test/src/WebAppTests.scala
diff --git a/...ib/web/5-webapp-scalajs-shared/build.mill → ...ib/web/6-webapp-scalajs-shared/build.mill b/...ib/web/5-webapp-scalajs-shared/build.mill → ...ib/web/6-webapp-scalajs-shared/build.mill
diff --git a/...scalajs-shared/client/src/ClientApp.scala → ...scalajs-shared/client/src/ClientApp.scala b/...scalajs-shared/client/src/ClientApp.scala → ...scalajs-shared/client/src/ClientApp.scala
diff --git a/.../9-todo-http4s/resources/webapp/index.css → ...scalajs-shared/resources/webapp/index.css b/.../9-todo-http4s/resources/webapp/index.css → ...scalajs-shared/resources/webapp/index.css
diff --git a/...pp-scalajs-shared/shared/src/Shared.scala → ...pp-scalajs-shared/shared/src/Shared.scala b/...pp-scalajs-shared/shared/src/Shared.scala → ...pp-scalajs-shared/shared/src/Shared.scala
diff --git a/.../5-webapp-scalajs-shared/src/WebApp.scala → .../6-webapp-scalajs-shared/src/WebApp.scala b/.../5-webapp-scalajs-shared/src/WebApp.scala → .../6-webapp-scalajs-shared/src/WebApp.scala
diff --git a/...scalajs-shared/test/src/WebAppTests.scala → ...scalajs-shared/test/src/WebAppTests.scala b/...scalajs-shared/test/src/WebAppTests.scala → ...scalajs-shared/test/src/WebAppTests.scala
diff --git a/...ss-version-platform-publishing/build.mill → ...ss-version-platform-publishing/build.mill b/...ss-version-platform-publishing/build.mill → ...ss-version-platform-publishing/build.mill
diff --git a/...ng/foo/bar/src-2/BarVersionSpecific.scala → ...ng/foo/bar/src-2/BarVersionSpecific.scala b/...ng/foo/bar/src-2/BarVersionSpecific.scala → ...ng/foo/bar/src-2/BarVersionSpecific.scala
diff --git a/...ng/foo/bar/src-3/BarVersionSpecific.scala → ...ng/foo/bar/src-3/BarVersionSpecific.scala b/...ng/foo/bar/src-3/BarVersionSpecific.scala → ...ng/foo/bar/src-3/BarVersionSpecific.scala
diff --git a/...platform-publishing/foo/bar/src/Bar.scala → ...platform-publishing/foo/bar/src/Bar.scala b/...platform-publishing/foo/bar/src/Bar.scala → ...platform-publishing/foo/bar/src/Bar.scala
diff --git a/...ublishing/foo/bar/test/src/BarTests.scala → ...ublishing/foo/bar/test/src/BarTests.scala b/...ublishing/foo/bar/test/src/BarTests.scala → ...ublishing/foo/bar/test/src/BarTests.scala
diff --git a/.../foo/qux/src-js/QuxPlatformSpecific.scala → .../foo/qux/src-js/QuxPlatformSpecific.scala b/.../foo/qux/src-js/QuxPlatformSpecific.scala → .../foo/qux/src-js/QuxPlatformSpecific.scala
diff --git a/...foo/qux/src-jvm/QuxPlatformSpecific.scala → ...foo/qux/src-jvm/QuxPlatformSpecific.scala b/...foo/qux/src-jvm/QuxPlatformSpecific.scala → ...foo/qux/src-jvm/QuxPlatformSpecific.scala
diff --git a/...platform-publishing/foo/qux/src/Qux.scala → ...platform-publishing/foo/qux/src/Qux.scala b/...platform-publishing/foo/qux/src/Qux.scala → ...platform-publishing/foo/qux/src/Qux.scala
diff --git a/...ublishing/foo/qux/test/src/QuxTests.scala → ...ublishing/foo/qux/test/src/QuxTests.scala b/...ublishing/foo/qux/test/src/QuxTests.scala → ...ublishing/foo/qux/test/src/QuxTests.scala
diff --git a/...ishing/bar/src-2/BarVersionSpecific.scala → ...ishing/bar/src-2/BarVersionSpecific.scala b/...ishing/bar/src-2/BarVersionSpecific.scala → ...ishing/bar/src-2/BarVersionSpecific.scala
diff --git a/...ishing/bar/src-3/BarVersionSpecific.scala → ...ishing/bar/src-3/BarVersionSpecific.scala b/...ishing/bar/src-3/BarVersionSpecific.scala → ...ishing/bar/src-3/BarVersionSpecific.scala
diff --git a/...form-version-publishing/bar/src/Bar.scala → ...form-version-publishing/bar/src/Bar.scala b/...form-version-publishing/bar/src/Bar.scala → ...form-version-publishing/bar/src/Bar.scala
diff --git a/...on-publishing/bar/test/src/BarTests.scala → ...on-publishing/bar/test/src/BarTests.scala b/...on-publishing/bar/test/src/BarTests.scala → ...on-publishing/bar/test/src/BarTests.scala
diff --git a/...ss-platform-version-publishing/build.mill → ...ss-platform-version-publishing/build.mill b/...ss-platform-version-publishing/build.mill → ...ss-platform-version-publishing/build.mill
diff --git a/...hing/qux/src-js/QuxPlatformSpecific.scala → ...hing/qux/src-js/QuxPlatformSpecific.scala b/...hing/qux/src-js/QuxPlatformSpecific.scala → ...hing/qux/src-js/QuxPlatformSpecific.scala
diff --git a/...ing/qux/src-jvm/QuxPlatformSpecific.scala → ...ing/qux/src-jvm/QuxPlatformSpecific.scala b/...ing/qux/src-jvm/QuxPlatformSpecific.scala → ...ing/qux/src-jvm/QuxPlatformSpecific.scala
diff --git a/...form-version-publishing/qux/src/Qux.scala → ...form-version-publishing/qux/src/Qux.scala b/...form-version-publishing/qux/src/Qux.scala → ...form-version-publishing/qux/src/Qux.scala
diff --git a/...on-publishing/qux/test/src/QuxTests.scala → ...on-publishing/qux/test/src/QuxTests.scala b/...on-publishing/qux/test/src/QuxTests.scala → ...on-publishing/qux/test/src/QuxTests.scala
diff --git a/example/scalalib/web/8-wasm/build.mill → example/scalalib/web/9-wasm/build.mill b/example/scalalib/web/8-wasm/build.mill → example/scalalib/web/9-wasm/build.mill
diff --git a/.../scalalib/web/8-wasm/wasm/src/hello.scala → .../scalalib/web/9-wasm/wasm/src/hello.scala b/.../scalalib/web/8-wasm/wasm/src/hello.scala → .../scalalib/web/9-wasm/wasm/src/hello.scala