From 4a11a6548d812b1f61739397a3ccaa331f76a494 Mon Sep 17 00:00:00 2001 From: hashAbhiBytes Date: Tue, 26 Nov 2024 17:54:28 +0530 Subject: [PATCH] Updated SQLAlchemy documentation in index.rst --- doc/build/index.rst | 239 +++++++++++++++++++++----------------------- 1 file changed, 112 insertions(+), 127 deletions(-) diff --git a/doc/build/index.rst b/doc/build/index.rst index 4a0065226a..45a60357c4 100644 --- a/doc/build/index.rst +++ b/doc/build/index.rst @@ -8,175 +8,160 @@ SQLAlchemy Documentation .. container:: left_right_container - .. container:: leftmost - - .. rst-class:: h2 + .. container:: leftmost - Getting Started + .. rst-class:: h2 + Getting Started - .. container:: + .. container:: - New to SQLAlchemy? Start here: + New to SQLAlchemy? Start here: - * **For Python Beginners:** :ref:`Installation Guide ` - basic guidance on installing with pip and similar + * **For Python Beginners:** :ref:`Installation Guide ` - Basic guidance on installing with pip and similar tools. - * **For Python Veterans:** :doc:`SQLAlchemy Overview ` - brief architectural overview + * **For Python Veterans:** :doc:`SQLAlchemy Overview ` - A brief architectural overview of SQLAlchemy. .. container:: left_right_container - .. container:: leftmost - - .. rst-class:: h2 - - Tutorials + .. container:: leftmost - .. container:: + .. rst-class:: h2 + Tutorials - New users of SQLAlchemy, as well as veterans of older SQLAlchemy - release series, should start with the - :doc:`/tutorial/index`, which covers everything an Alchemist needs - to know when using the ORM or just Core. + .. container:: - * **For a quick glance:** :doc:`/orm/quickstart` - a glimpse at what working with the ORM looks like + New users of SQLAlchemy, as well as veterans of older SQLAlchemy release series, should start with the + :doc:`/tutorial/index`, which covers everything an Alchemist needs to know when using the ORM or just Core. - * **For all users:** :doc:`/tutorial/index` - In depth tutorial for Core and ORM + * **For a quick glance:** :doc:`/orm/quickstart` - A brief overview of what working with the ORM looks like. + * **For all users:** :doc:`/tutorial/index` - In-depth tutorial for both Core and ORM usage. .. container:: left_right_container - .. container:: leftmost - - .. rst-class:: h2 + .. container:: leftmost - Migration Notes + .. rst-class:: h2 + Migration Notes - .. container:: + .. container:: - Users coming SQLAlchemy version 2.0 will want to read: + Users upgrading to SQLAlchemy version 2.0 will want to read: - * :doc:`What's New in SQLAlchemy 2.1? ` - New features and behaviors in version 2.1 + * :doc:`What's New in SQLAlchemy 2.1? ` - New features and behaviors in version 2.1. - Users transitioning from 1.x versions of SQLAlchemy, such as version 1.4, will want to - transition to version 2.0 overall before making any additional changes needed for - the much smaller transition from 2.0 to 2.1. Key documentation for the 1.x to 2.x - transition: + Users transitioning from version 1.x of SQLAlchemy (e.g., version 1.4) should first transition to version 2.0 + before making any additional changes needed for the smaller transition from 2.0 to 2.1. Key documentation for the 1.x to 2.x transition: - * :doc:`Migrating to SQLAlchemy 2.0 ` - Complete background on migrating from 1.3 or 1.4 to 2.0 - * :doc:`What's New in SQLAlchemy 2.0? ` - New 2.0 features and behaviors beyond the 1.x migration + * :doc:`Migrating to SQLAlchemy 2.0 ` - Complete background on migrating from 1.3 or 1.4 to 2.0. - An index of all changelogs and migration documentation is at: + * :doc:`What's New in SQLAlchemy 2.0? ` - New features and behaviors introduced in version 2.0 beyond the 1.x migration. - * :doc:`Changelog catalog ` - Detailed changelogs for all SQLAlchemy Versions + An index of all changelogs and migration documentation is available here: + * :doc:`Changelog catalog ` - Detailed changelogs for all SQLAlchemy versions. .. container:: left_right_container - .. container:: leftmost - - .. rst-class:: h2 - - Reference and How To - - - .. container:: orm - - **SQLAlchemy ORM** - Detailed guides and API reference for using the ORM - - * **Mapping Classes:** - :doc:`Mapping Python Classes ` | - :doc:`Relationship Configuration ` - - * **Using the ORM:** - :doc:`Using the ORM Session ` | - :doc:`ORM Querying Guide ` | - :doc:`Using AsyncIO ` - - * **Configuration Extensions:** - :doc:`Association Proxy ` | - :doc:`Hybrid Attributes ` | - :doc:`Mutable Scalars ` | - :doc:`Automap ` | - :doc:`All extensions ` - - * **Extending the ORM:** - :doc:`ORM Events and Internals ` - - * **Other:** - :doc:`Introduction to Examples ` - - .. container:: core - - **SQLAlchemy Core** - Detailed guides and API reference for working with Core - - * **Engines, Connections, Pools:** - :doc:`Engine Configuration ` | - :doc:`Connections, Transactions, Results ` | - :doc:`AsyncIO Support ` | - :doc:`Connection Pooling ` - - * **Schema Definition:** - :doc:`Overview ` | - :ref:`Tables and Columns ` | - :ref:`Database Introspection (Reflection) ` | - :ref:`Insert/Update Defaults ` | - :ref:`Constraints and Indexes ` | - :ref:`Using Data Definition Language (DDL) ` - - * **SQL Statements:** - :doc:`SQL Expression Elements ` | - :doc:`Operator Reference ` | - :doc:`SELECT and related constructs ` | - :doc:`INSERT, UPDATE, DELETE ` | - :doc:`SQL Functions ` | - :doc:`Table of Contents ` - - - - * **Datatypes:** - :ref:`Overview ` | - :ref:`Building Custom Types ` | - :ref:`Type API Reference ` + .. container:: leftmost - * **Core Basics:** - :doc:`Overview ` | - :doc:`Runtime Inspection API ` | - :doc:`Event System ` | - :doc:`Core Event Interfaces ` | - :doc:`Creating Custom SQL Constructs ` + .. rst-class:: h2 + Reference and How-To + + .. container:: orm + + **SQLAlchemy ORM** - Detailed guides and API reference for using the ORM. + + * **Mapping Classes:** + :doc:`Mapping Python Classes ` | + :doc:`Relationship Configuration ` + + * **Using the ORM:** + :doc:`Using the ORM Session ` | + :doc:`ORM Querying Guide ` | + :doc:`Using AsyncIO ` + + * **Configuration Extensions:** + :doc:`Association Proxy ` | + :doc:`Hybrid Attributes ` | + :doc:`Mutable Scalars ` | + :doc:`Automap ` | + :doc:`All extensions ` + + * **Extending the ORM:** + :doc:`ORM Events and Internals ` + + * **Other:** + :doc:`Introduction to Examples ` + + .. container:: core + + **SQLAlchemy Core** - Detailed guides and API reference for working with Core. + + * **Engines, Connections, Pools:** + :doc:`Engine Configuration ` | + :doc:`Connections, Transactions, Results ` | + :doc:`AsyncIO Support ` | + :doc:`Connection Pooling ` + + * **Schema Definition:** + :doc:`Overview ` | + :ref:`Tables and Columns ` | + :ref:`Database Introspection (Reflection) ` | + :ref:`Insert/Update Defaults ` | + :ref:`Constraints and Indexes ` | + :ref:`Using Data Definition Language (DDL) ` + + * **SQL Statements:** + :doc:`SQL Expression Elements ` | + :doc:`Operator Reference ` | + :doc:`SELECT and related constructs ` | + :doc:`INSERT, UPDATE, DELETE ` | + :doc:`SQL Functions ` | + :doc:`Table of Contents ` + + * **Datatypes:** + :ref:`Overview ` | + :ref:`Building Custom Types ` | + :ref:`Type API Reference ` + + * **Core Basics:** + :doc:`Overview ` | + :doc:`Runtime Inspection API ` | + :doc:`Event System ` | + :doc:`Core Event Interfaces ` | + :doc:`Creating Custom SQL Constructs ` .. container:: left_right_container .. container:: leftmost - .. rst-class:: h2 - - Dialect Documentation + .. rst-class:: h2 + Dialect Documentation .. container:: - The **dialect** is the system SQLAlchemy uses to communicate with various types of DBAPIs and databases. - This section describes notes, options, and usage patterns regarding individual dialects. + The **dialect** is the system SQLAlchemy uses to communicate with various types of DBAPIs and databases. This section describes notes, options, and usage patterns regarding individual dialects. - :doc:`PostgreSQL ` | - :doc:`MySQL and MariaDB ` | - :doc:`SQLite ` | - :doc:`Oracle Database ` | - :doc:`Microsoft SQL Server ` + :doc:`PostgreSQL ` | + :doc:`MySQL and MariaDB ` | + :doc:`SQLite ` | + :doc:`Oracle Database ` | + :doc:`Microsoft SQL Server ` - :doc:`More Dialects ... ` + :doc:`More Dialects ... ` .. container:: left_right_container - .. container:: leftmost - - .. rst-class:: h2 + .. container:: leftmost - Supplementary + .. rst-class:: h2 + Supplementary - .. container:: + .. container:: - * :doc:`Frequently Asked Questions ` - A collection of common problems and solutions - * :doc:`Glossary ` - Terms used in SQLAlchemy's documentation - * :doc:`Error Message Guide ` - Explanations of many SQLAlchemy Errors - * :doc:`Complete table of of contents ` - * :ref:`Index ` + * :doc:`Frequently Asked Questions ` - A collection of common problems and solutions. + * :doc:`Glossary ` - Definitions of terms used in SQLAlchemy documentation. + * :doc:`Error Message Guide ` - Explanations of common SQLAlchemy errors. + * :doc:`Complete table of contents ` - Full list of available documentation. + * :ref:`Index ` - Index for easy lookup of documentation topics. -- 2.47.3