Rework docs and examples (#198)

* Docs / examples rework * nits * Refinements * ruff * ignore mypy errors for docs update script
brentyi · Nov 7, 2024 · 445155a · 445155a
1 parent afd5486
commit 445155a
Show file tree

Hide file tree

Showing 98 changed files with 3,922 additions and 2,906 deletions.
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@
 <br />
 
 <strong><code>tyro.cli()</code></strong> is a tool for generating CLI
-interfaces.
+interfaces in Python.
 
 We can define configurable scripts using functions:
 
@@ -211,9 +211,10 @@ particularly like:
   [jsonargparse](https://github.com/omni-us/jsonargparse), which provide deeper
   integration with configuration file formats like YAML and JSON.
 - [clipstick](https://github.com/sander76/clipstick), which focuses on
-  generating CLIs from Pydantic models.
+  simplicity + generating CLIs from Pydantic models.
 - [datargs](https://github.com/roee30/datargs), which provides a minimal API for
   dataclasses.
+- [defopt](https://defopt.readthedocs.io/), which has similarly comprehensive type annotation support.
 - [fire](https://github.com/google/python-fire) and
   [clize](https://github.com/epsy/clize), which support arguments without type
   annotations.

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,6 +3,7 @@ furo==2024.8.6
 docutils==0.20.1
 sphinx-autoapi==3.0.0
 m2r2==0.3.3.post2
+ansi2html==1.9.2
 git+https://github.com/brentyi/sphinxcontrib-programoutput.git
 git+https://github.com/brentyi/ansi.git
 sphinxcontrib-googleanalytics==0.4
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -112,7 +112,7 @@
 exclude_patterns: List[str] = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "monokai"
+pygments_style = "default"
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/source/examples/01_basics/01_functions.rst b/docs/source/examples/01_basics/01_functions.rst
diff --git a/docs/source/examples/01_basics/02_dataclasses.rst b/docs/source/examples/01_basics/02_dataclasses.rst
diff --git a/docs/source/examples/01_basics/03_dataclasses_defaults.rst b/docs/source/examples/01_basics/03_dataclasses_defaults.rst
diff --git a/docs/source/examples/01_basics/04_collections.rst b/docs/source/examples/01_basics/04_collections.rst
diff --git a/docs/source/examples/01_basics/05_flags.rst b/docs/source/examples/01_basics/05_flags.rst