From da64d90f2723b78d41425eca7a61d0af8a365e5c Mon Sep 17 00:00:00 2001 From: Daniele Varrazzo Date: Fri, 12 Mar 2021 05:06:15 +0100 Subject: [PATCH] Divide docs file into chapter directories --- docs/{adaptation.rst => advanced/adapt.rst} | 0 docs/{ => advanced}/async.rst | 0 docs/{ => advanced}/copy.rst | 0 docs/{ => advanced}/cursors.rst | 0 docs/advanced/index.rst | 14 +++++++------- .../pool.rst} | 0 docs/{prepared.rst => advanced/prepare.rst} | 0 docs/{row-factories.rst => advanced/rows.rst} | 0 docs/{connection.rst => api/connections.rst} | 0 docs/{cursor.rst => api/cursors.rst} | 0 docs/{ => api}/errors.rst | 0 docs/api/index.rst | 14 +++++++------- docs/{ => api}/pool.rst | 0 docs/{ => api}/pq.rst | 0 docs/{ => api}/sql.rst | 0 docs/{ => api}/types.rst | 0 docs/{adapt-types.rst => basic/adapt.rst} | 0 docs/basic/index.rst | 18 +++++------------- docs/{ => basic}/install.rst | 0 docs/{ => basic}/params.rst | 0 docs/{ => basic}/transactions.rst | 0 docs/{ => basic}/usage.rst | 0 22 files changed, 19 insertions(+), 27 deletions(-) rename docs/{adaptation.rst => advanced/adapt.rst} (100%) rename docs/{ => advanced}/async.rst (100%) rename docs/{ => advanced}/copy.rst (100%) rename docs/{ => advanced}/cursors.rst (100%) rename docs/{connection-pools.rst => advanced/pool.rst} (100%) rename docs/{prepared.rst => advanced/prepare.rst} (100%) rename docs/{row-factories.rst => advanced/rows.rst} (100%) rename docs/{connection.rst => api/connections.rst} (100%) rename docs/{cursor.rst => api/cursors.rst} (100%) rename docs/{ => api}/errors.rst (100%) rename docs/{ => api}/pool.rst (100%) rename docs/{ => api}/pq.rst (100%) rename docs/{ => api}/sql.rst (100%) rename docs/{ => api}/types.rst (100%) rename docs/{adapt-types.rst => basic/adapt.rst} (100%) rename docs/{ => basic}/install.rst (100%) rename docs/{ => basic}/params.rst (100%) rename docs/{ => basic}/transactions.rst (100%) rename docs/{ => basic}/usage.rst (100%) diff --git a/docs/adaptation.rst b/docs/advanced/adapt.rst similarity index 100% rename from docs/adaptation.rst rename to docs/advanced/adapt.rst diff --git a/docs/async.rst b/docs/advanced/async.rst similarity index 100% rename from docs/async.rst rename to docs/advanced/async.rst diff --git a/docs/copy.rst b/docs/advanced/copy.rst similarity index 100% rename from docs/copy.rst rename to docs/advanced/copy.rst diff --git a/docs/cursors.rst b/docs/advanced/cursors.rst similarity index 100% rename from docs/cursors.rst rename to docs/advanced/cursors.rst diff --git a/docs/advanced/index.rst b/docs/advanced/index.rst index b00eb2667..430261953 100644 --- a/docs/advanced/index.rst +++ b/docs/advanced/index.rst @@ -5,10 +5,10 @@ Advanced topics :maxdepth: 1 :caption: Contents: - ../async - ../copy - ../cursors - ../row-factories - ../connection-pools - ../adaptation - ../prepared + async + copy + cursors + rows + pool + adapt + prepare diff --git a/docs/connection-pools.rst b/docs/advanced/pool.rst similarity index 100% rename from docs/connection-pools.rst rename to docs/advanced/pool.rst diff --git a/docs/prepared.rst b/docs/advanced/prepare.rst similarity index 100% rename from docs/prepared.rst rename to docs/advanced/prepare.rst diff --git a/docs/row-factories.rst b/docs/advanced/rows.rst similarity index 100% rename from docs/row-factories.rst rename to docs/advanced/rows.rst diff --git a/docs/connection.rst b/docs/api/connections.rst similarity index 100% rename from docs/connection.rst rename to docs/api/connections.rst diff --git a/docs/cursor.rst b/docs/api/cursors.rst similarity index 100% rename from docs/cursor.rst rename to docs/api/cursors.rst diff --git a/docs/errors.rst b/docs/api/errors.rst similarity index 100% rename from docs/errors.rst rename to docs/api/errors.rst diff --git a/docs/api/index.rst b/docs/api/index.rst index c9b73a0a1..bff99ec29 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -5,10 +5,10 @@ :maxdepth: 1 :caption: Contents: - ../connection - ../cursor - ../sql - ../errors - ../pool - ../types - ../pq + connections + cursors + sql + errors + pool + types + pq diff --git a/docs/pool.rst b/docs/api/pool.rst similarity index 100% rename from docs/pool.rst rename to docs/api/pool.rst diff --git a/docs/pq.rst b/docs/api/pq.rst similarity index 100% rename from docs/pq.rst rename to docs/api/pq.rst diff --git a/docs/sql.rst b/docs/api/sql.rst similarity index 100% rename from docs/sql.rst rename to docs/api/sql.rst diff --git a/docs/types.rst b/docs/api/types.rst similarity index 100% rename from docs/types.rst rename to docs/api/types.rst diff --git a/docs/adapt-types.rst b/docs/basic/adapt.rst similarity index 100% rename from docs/adapt-types.rst rename to docs/basic/adapt.rst diff --git a/docs/basic/index.rst b/docs/basic/index.rst index ef08a0a9f..e75385642 100644 --- a/docs/basic/index.rst +++ b/docs/basic/index.rst @@ -6,16 +6,8 @@ Getting started with ``psycopg3`` :maxdepth: 1 :caption: Contents: - ../install - ../usage - ../params - ../adapt-types - ../transactions - - -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + install + usage + params + adapt + transactions diff --git a/docs/install.rst b/docs/basic/install.rst similarity index 100% rename from docs/install.rst rename to docs/basic/install.rst diff --git a/docs/params.rst b/docs/basic/params.rst similarity index 100% rename from docs/params.rst rename to docs/basic/params.rst diff --git a/docs/transactions.rst b/docs/basic/transactions.rst similarity index 100% rename from docs/transactions.rst rename to docs/basic/transactions.rst diff --git a/docs/usage.rst b/docs/basic/usage.rst similarity index 100% rename from docs/usage.rst rename to docs/basic/usage.rst -- 2.47.2