Skip to content

Commit 28e5a5f

Browse files
committed
1st pass at converting Usage doc from Sphinx to simple markdown
1 parent c775622 commit 28e5a5f

23 files changed

+97
-716
lines changed

doc/Makefile

Lines changed: 0 additions & 177 deletions
This file was deleted.

doc/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
# Multicorn2
3+
4+
5+
Multicorn2 is a PostgreSQL 14++ extension meant to make `Foreign Data Wrapper`
6+
development easy, by allowing the programmer to use the Python programming
7+
language.
8+
9+
If you just want to use it as soon as possible, jump straight to the
10+
`installation` section.
11+
12+
13+
## Table of Contents
14+
- installation.md
15+
- getting-started.md
16+
- foreign-data-wrappers.md
17+
- implementing-an-fdw.md
18+
- third-party-fdw.md
19+
- internals.md
20+
- contribute.md
21+

doc/_static/css/custom.css

Lines changed: 0 additions & 42 deletions
This file was deleted.
-330 Bytes
Binary file not shown.
-317 Bytes
Binary file not shown.
-344 Bytes
Binary file not shown.
-299 Bytes
Binary file not shown.

doc/api.rst renamed to doc/api.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
***
2-
API
3-
***
1+
# API
42

53
The API is split into two modules: the ``multicorn`` module and the
64
`utils` module:
@@ -11,16 +9,14 @@ The API is split into two modules: the ``multicorn`` module and the
119
which are ultimately implemented as calls to the PostgreSQL API.
1210

1311

14-
Implementing an FDW
15-
===================
12+
## Implementing an FDW
1613

1714
Implementing an FDW is as simple as implementing the
1815
:py:class:`~multicorn.ForeignDataWrapper` class.
1916

2017

2118

22-
Required API
23-
------------
19+
### Required API
2420

2521
.. py:currentmodule:: multicorn.ForeignDataWrapper
2622

@@ -37,8 +33,7 @@ You have to implement the following methods:
3733
.. api_compat:: :read:
3834

3935

40-
Write API
41-
---------
36+
### Write API
4237

4338
To implement full write capabilites, the following property must be implemented:
4439

@@ -58,8 +53,7 @@ In addition to that, you should implement each DML operation as you see fit:
5853
.. api_compat::
5954
:write:
6055

61-
Transactional API
62-
-----------------
56+
### Transactional API
6357

6458
Transactional Capabilities can be implemented with the following methods:
6559

@@ -77,8 +71,7 @@ Transactional Capabilities can be implemented with the following methods:
7771
:transaction:
7872

7973

80-
Full API
81-
========
74+
### Full API
8275

8376
.. autoclass:: multicorn.ForeignDataWrapper
8477
:special-members: __init__

0 commit comments

Comments
 (0)