๐Ÿ“ฆ ftnext / sphinx-notion

โ˜… 3 stars โ‘‚ 0 forks ๐Ÿ‘ 3 watching โš–๏ธ MIT License
๐Ÿ“ฅ Clone https://github.com/ftnext/sphinx-notion.git
HTTPS git clone https://github.com/ftnext/sphinx-notion.git
SSH git clone git@github.com:ftnext/sphinx-notion.git
CLI gh repo clone ftnext/sphinx-notion
ftnext ftnext [chore] Bump up 0.0.7 82c631c 2 months ago ๐Ÿ“ History
๐Ÿ“‚ main View all commits โ†’
๐Ÿ“ .github
๐Ÿ“ example
๐Ÿ“ src
๐Ÿ“ tests
๐Ÿ“„ .gitignore
๐Ÿ“„ AGENTS.md
๐Ÿ“„ LICENSE
๐Ÿ“„ pyproject.toml
๐Ÿ“„ README.md
๐Ÿ“„ setup.py
๐Ÿ“„ upload.py
๐Ÿ“„ README.md

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

  • Create your Sphinx documentation
  • Edit conf.py to use this extension
extensions = [
    "sphinx_notion",
]

  • 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.