diff --git a/docs/index.rst b/docs/index.rst index bad1f3df..a2be03a6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,14 +2,6 @@ Static Typing with Python ************************* -.. Introduction -.. ============ -.. -.. .. toctree:: -.. :maxdepth: 2 -.. -.. source/introduction - Guides ====== diff --git a/docs/source/annotations.rst b/docs/source/annotations.rst deleted file mode 100644 index ea5c471f..00000000 --- a/docs/source/annotations.rst +++ /dev/null @@ -1,68 +0,0 @@ -**************** -Type Annotations -**************** - -Functions -========= - -Parameters ----------- - -Asynchronous Functions ----------------------- - -Generators ----------- - -Lambdas -------- - - -Classes -======= - -Overloads and Overrides ------------------------ - -Instance vs. Class Attributes ------------------------------ - -Final attributes ----------------- - -Abstract base classes ---------------------- - - -Globals -======= - - -Attributes -========== - - -Locals -====== - -Empty Containers ----------------- - - -Runtime Considerations -====================== - -Comment vs. Inline Support --------------------------- - -Forward References ------------------- - -Generic types that don't implement `__getitem__` ------------------------------------------------- - -Conditioning on static type checking ------------------------------------- - -from `__future__` import annotations ------------------------------------- diff --git a/docs/source/basics.rst b/docs/source/basics.rst deleted file mode 100644 index 9b2bf52a..00000000 --- a/docs/source/basics.rst +++ /dev/null @@ -1,3 +0,0 @@ -********** -The Basics -********** diff --git a/docs/source/dependencies.rst b/docs/source/dependencies.rst deleted file mode 100644 index b16fa639..00000000 --- a/docs/source/dependencies.rst +++ /dev/null @@ -1,12 +0,0 @@ -************************** -Libraries and Dependencies -************************** - -:doc:`libraries` - -Typeshed -======== - - -Placeholder Stubs -================= diff --git a/docs/source/faq.rst b/docs/source/faq.rst deleted file mode 100644 index 906e2779..00000000 --- a/docs/source/faq.rst +++ /dev/null @@ -1,23 +0,0 @@ -************************** -Frequently Asked Questions -************************** - - -Why Types? -========== - - -Unsupported Python Features -=========================== - - -Common Errors -============= - - -Typing PEPs -=========== - - -Relevant Talks and Resources -============================ diff --git a/docs/source/inference.rst b/docs/source/inference.rst deleted file mode 100644 index 291dec48..00000000 --- a/docs/source/inference.rst +++ /dev/null @@ -1,28 +0,0 @@ -************** -Type Inference -************** - -Rules for local inference -========================= - -Explicit vs. Implicit Local Types ---------------------------------- - -Changing Types -============== - -Asserts -------- - -Casts ------ - -Type Guards ------------ - - -Protocols and Duck Typing -========================= - -Callback Protocols ------------------- diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst deleted file mode 100644 index fb973559..00000000 --- a/docs/source/introduction.rst +++ /dev/null @@ -1,41 +0,0 @@ -******************************* -Introduction to Types in Python -******************************* - - -Background -========== - -How to read type annotations ----------------------------- - -When and why types are useful ------------------------------ - - -Gradual Typing: Static Types in a Dynamic Language -================================================== - -Opt-in type checking --------------------- - -Type stubs ----------- - -:doc:`stubs` - -Strategies for increasing coverage ----------------------------------- - - -Getting Started -=============== - -Python type checkers --------------------- - -How to annotate an existing codebase ------------------------------------- - -Typeshed --------- diff --git a/docs/source/reference.rst b/docs/source/reference.rst index 54afcc7b..010f3b49 100644 --- a/docs/source/reference.rst +++ b/docs/source/reference.rst @@ -12,14 +12,3 @@ Type System Reference best_practices quality typing Module Documentation - -.. The following pages are desired in a new TOC which will cover multiple -.. topics. For now, they are not linked because the pages are empty. -.. -.. basics -.. type_system -.. annotations -.. inference -.. type_compatibility -.. dependencies -.. faq diff --git a/docs/source/type_compatibility.rst b/docs/source/type_compatibility.rst deleted file mode 100644 index 43ebd32b..00000000 --- a/docs/source/type_compatibility.rst +++ /dev/null @@ -1,17 +0,0 @@ -****************** -Type Compatibility -****************** - - -The Class Hierarchy -=================== - -Mutable Containers ------------------- - -Comparing Callables: Covariance and Contravariance --------------------------------------------------- - - -Metaclasses -=========== diff --git a/docs/source/type_system.rst b/docs/source/type_system.rst deleted file mode 100644 index 6d7954b8..00000000 --- a/docs/source/type_system.rst +++ /dev/null @@ -1,58 +0,0 @@ -*************** -The Type System -*************** - -Built-in Types -============== - -`typing Module Documentation `__ - -Built-in Primitives -------------------- - -Built-in operators ------------------- - -Advanced Types --------------- - - -Simple User-Defined Types -========================= - - -Type Aliases -============ - -Recursive Aliases ------------------ - - -Data Structures -=============== - -Typed Dictionary ----------------- - -Dataclass ---------- - - -Generic Types -============= - - -Type Variables -============== - -TypeVar -------- - -Variadics ---------- - -ParamSpec -^^^^^^^^^ - -TypeVarTuple -^^^^^^^^^^^^