summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2021-02-10 10:13:45 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2021-02-10 10:14:26 -0500
commitc36391bcd2936ee3eca0f6e359da5de6fcd93bd1 (patch)
tree870bd1adc21c2194a6a3ec6ea45a0496ba8bbab4
parent1e75c189da721395bc8c2d899c722a5b9a170404 (diff)
downloadsqlalchemy-c36391bcd2936ee3eca0f6e359da5de6fcd93bd1.tar.gz
turn section into a bulleted list
Change-Id: I18f047a999bd48d6d0e3c495a0ca675b042c1bb6 (cherry picked from commit 95916d658c9c0a812f3ed33830260a0924439035)
-rw-r--r--doc/build/intro.rst43
1 files changed, 23 insertions, 20 deletions
diff --git a/doc/build/intro.rst b/doc/build/intro.rst
index 9451d92bd..877b67bdd 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
=============