Skip to content

Commit 5d2ca2c

Browse files
committed
2nd pass at Doc in markdown (rather than Sphinx)
1 parent 28e5a5f commit 5d2ca2c

16 files changed

+126
-137
lines changed

CHANGELOG

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
3.1:
2-
- drop support for Postgres versions prior to 14
32
- add support for Python 3.13
43
- add support for pg18
4+
- drop support for Postgres versions prior to 14
5+
- rework usage Doc from Sphinx into simple Markdown
56

67
3.0:
78
- drop support for Python 3 versions prior to 3.9

doc/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Multicorn2
33

44

5-
Multicorn2 is a PostgreSQL 14++ extension meant to make `Foreign Data Wrapper`
5+
Multicorn2 is a PostgreSQL extension meant to make `Foreign Data Wrapper`
66
development easy, by allowing the programmer to use the Python programming
77
language.
88

@@ -11,11 +11,10 @@ If you just want to use it as soon as possible, jump straight to the
1111

1212

1313
## 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-
14+
- [Installation](installation.md)
15+
- [Getting Started](getting-started.md)
16+
- [Foreign Data Wrappers](foreign-data-wrappers.md)
17+
- [Implementing an FDW](implementing-an-fdw.md)
18+
- [Third Party FDW's](third-party-fdw.md)
19+
- [Internals](internals.md)
20+
- [Contribute](contribute.md)

doc/contribute.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
# Contribute
22

3-
If you use Multicorn2 in production, we would love to hear about your use-case !
3+
If you use Multicorn2 in production, we would love to hear about your use-case!
44

55

66
## Report Bugs
77

8-
Found a bug? Want a new feature? Report a new issue on the `Multicorn2
9-
bug-tracker on GitHub <https://github.com/pgsql-io/Multicorn2/issues/>`.
8+
Found a bug? Want a new feature? Use our [Issue Tracker](https://github.com/pgsql-io/multicorn2/issues/)
109

1110

1211
## Hack
1312

14-
Interested in hacking? Feel free to clone the `git repository on
15-
GitHub <https://github.com/pgsql-io/Multicorn2>` if you want to add new features, fix bugs or update documentation.
13+
Interested in hacking? Feel free to clone [https://github.com/pgsql-io/Multicorn2](https://github.com/pgsql-io/multicorn2) if you want to add new features, fix bugs or update documentation.

doc/foreign-data-wrappers.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Multicorn is bundled with a small set of Foreign Data Wrappers, which you can
44
use or customize for your needs.
55

66

7-
/foreign-data-wrappers/sqlalchemyfdw.md
8-
/foreign-data-wrappers/fsfdw.md
9-
/foreign-data-wrappers/imapfdw.md
10-
/foreign-data-wrappers/ldapfdw.md
11-
/foreign-data-wrappers/csvfdw.md
12-
/foreign-data-wrappers/rssfdw.md
13-
/foreign-data-wrappers/processfdw.md
7+
- [sqlalchemy](/foreign-data-wrappers/sqlalchemyfdw.md)
8+
- [fsfdw](/foreign-data-wrappers/fsfdw.md)
9+
- [imapfdw](/foreign-data-wrappers/imapfdw.md)
10+
- [ldapfdw](/foreign-data-wrappers/ldapfdw.md)
11+
- [csvfdw](/foreign-data-wrappers/csvfdw.md)
12+
- [rssfdw](/foreign-data-wrappers/rssfdw.md)
13+
- [processfdw](/foreign-data-wrappers/processfdw.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)