Metadata-Version: 2.4
Name: sphinx-notion
Version: 0.0.3
Summary: Sphinx extension to generate JSON for Notion API from Sphinx documentation
Author-email: nikkie <takuyafjp+develop@gmail.com>
License: MIT License
Project-URL: Repository, https://github.com/ftnext/sphinx-notion
Keywords: Sphinx,Notion
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Sphinx
Provides-Extra: dev
Requires-Dist: taskipy; extra == "dev"
Requires-Dist: autoflake; extra == "dev"
Requires-Dist: pyupgrade; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-randomly; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: types-docutils; extra == "dev"
Dynamic: license-file

# 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).
