]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
turn section into a bulleted list
authorMike Bayer <mike_mp@zzzcomputing.com>
Wed, 10 Feb 2021 15:13:45 +0000 (10:13 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Wed, 10 Feb 2021 15:14:26 +0000 (10:14 -0500)
Change-Id: I18f047a999bd48d6d0e3c495a0ca675b042c1bb6
(cherry picked from commit 95916d658c9c0a812f3ed33830260a0924439035)

doc/build/intro.rst

index 9451d92bd1ce38b4bf4f2e6188786787bf4cf76f..877b67bdd16e8403977f0737d352826848921cba 100644 (file)
@@ -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
 =============