From: Mike Bayer Date: Wed, 10 Feb 2021 15:13:45 +0000 (-0500) Subject: turn section into a bulleted list X-Git-Tag: rel_1_4_0b3~17 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c36391bcd2936ee3eca0f6e359da5de6fcd93bd1;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git turn section into a bulleted list Change-Id: I18f047a999bd48d6d0e3c495a0ca675b042c1bb6 (cherry picked from commit 95916d658c9c0a812f3ed33830260a0924439035) --- diff --git a/doc/build/intro.rst b/doc/build/intro.rst index 9451d92bd1..877b67bdd1 100644 --- a/doc/build/intro.rst +++ b/doc/build/intro.rst @@ -53,26 +53,29 @@ is command oriented whereas the ORM is state oriented. Documentation Overview ====================== -The documentation is separated into four sections: :ref:`unified_tutorial`, -:ref:`orm_toplevel`, -:ref:`core_toplevel`, and :ref:`dialect_toplevel`. - -In :ref:`unified_tutorial`, this all-new tutorial for the 1.4/2.0 series -of SQLAlchemy introduces the entire library holistically, starting -from a description of Core and working more and more towards ORM-specific -concepts. New users, as well as users coming from :term:`1.x style`, -who wish to work in :term:`2.0 style` should start here. - -In :ref:`orm_toplevel`, reference documentation for the ORM is presented; this -section also includes the now-legacy :ref:`ormtutorial_toplevel`. - -In :ref:`core_toplevel`, reference documentation for everything else within -Core is presented; section also includes the legacy :ref:`sqlexpression_toplevel`. -SQLAlchemy engine, connection, and pooling services are also described in -:ref:`core_toplevel`. - -In :ref:`dialect_toplevel`, reference documentation for all provided -database and DBAPI backends is provided. +The documentation is separated into four sections: + +* :ref:`unified_tutorial` - this all-new tutorial for the 1.4/2.0 series of + SQLAlchemy introduces the entire library holistically, starting from a + description of Core and working more and more towards ORM-specific concepts. + New users, as well as users coming from :term:`1.x style`, who wish to work + in :term:`2.0 style` should start here. + +* :ref:`orm_toplevel` - In this section, reference documentation for the ORM is + presented; this section also includes the now-legacy + :ref:`ormtutorial_toplevel`. + +* :ref:`core_toplevel` - Here, reference documentation for + everything else within Core is presented; section also includes the legacy + :ref:`sqlexpression_toplevel`. SQLAlchemy engine, connection, and pooling + services are also described here. + +* :ref:`dialect_toplevel` - Provides reference documentation + for all :term:`dialect` implementations, including :term:`DBAPI` specifics. + + + + Code Examples =============