1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34# sphinx-notion
`sphinx-notion` is a Sphinx extension that converts manuscripts (reST, etc.) to a Notion API compatible JSON file.
`sphinx-notion` adds `notion` builder.
## Example
* reST: https://github.com/ftnext/sphinx-notion/tree/main/example
* Notion page: https://actually-divan-348.notion.site/sphin-notion-example-index-rst-1dce5fe10a37818098a0fd61578b06d3
## Usage
1. Create your Sphinx documentation
2. Edit `conf.py` to use this extension
```python
extensions = [
"sphinx_notion",
]
```
3. Run `make notion`
Or other command example:
```
uvx --from Sphinx \
--with sphinx-notion \
sphinx-build -M notion source build
```
Optional: Upload a JSON file under `build/notion/` with a [script](https://github.com/ftnext/sphinx-notion/blob/main/upload.py).