sphinx-notion

Name	sphinx-notion JSON
Version	0.0.4 JSON
	download
home_page	None
Summary	Sphinx extension to generate JSON for Notion API from Sphinx documentation
upload_time	2025-08-20 11:43:54
maintainer	None
docs_url	None
author	None
requires_python	>=3.9
license	MIT License
keywords	sphinx notion
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sphinx-notion",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "Sphinx, Notion",
    "author": null,
    "author_email": "nikkie <takuyafjp+develop@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/a8/ab/9ca77c94ab06e5365ee3cf62aa27b957876232cb28db0a7baae4a32306dc/sphinx_notion-0.0.4.tar.gz",
    "platform": null,
    "description": "# sphinx-notion\n\n`sphinx-notion` is a Sphinx extension that converts manuscripts (reST, etc.) to a Notion API compatible JSON file.\n\n`sphinx-notion` adds `notion` builder.\n\n## Example\n\n* reST: https://github.com/ftnext/sphinx-notion/tree/main/example\n* Notion page: https://actually-divan-348.notion.site/sphin-notion-example-index-rst-1dce5fe10a37818098a0fd61578b06d3\n\n## Usage\n\n1. Create your Sphinx documentation\n2. Edit `conf.py` to use this extension\n\n```python\nextensions = [\n    \"sphinx_notion\",\n]\n```\n\n3. Run `make notion`\n\nOr other command example:\n\n```\nuvx --from Sphinx \\\n  --with sphinx-notion \\\n  sphinx-build -M notion source build\n```\n\nOptional: Upload a JSON file under `build/notion/` with a [script](https://github.com/ftnext/sphinx-notion/blob/main/upload.py).\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Sphinx extension to generate JSON for Notion API from Sphinx documentation",
    "version": "0.0.4",
    "project_urls": {
        "Repository": "https://github.com/ftnext/sphinx-notion"
    },
    "split_keywords": [
        "sphinx",
        " notion"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cbff04030206cb0350c54be2e6f6bf1a5a52e12e50e8ce7500c2a55005b7ffeb",
                "md5": "c5f16fabbf967d634ac35b8e5efe2710",
                "sha256": "4b842168b924f862228e7c110832eca7fb0a23fcac2a521ffb330eca53dce842"
            },
            "downloads": -1,
            "filename": "sphinx_notion-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c5f16fabbf967d634ac35b8e5efe2710",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 5389,
            "upload_time": "2025-08-20T11:43:52",
            "upload_time_iso_8601": "2025-08-20T11:43:52.538285Z",
            "url": "https://files.pythonhosted.org/packages/cb/ff/04030206cb0350c54be2e6f6bf1a5a52e12e50e8ce7500c2a55005b7ffeb/sphinx_notion-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a8ab9ca77c94ab06e5365ee3cf62aa27b957876232cb28db0a7baae4a32306dc",
                "md5": "af280365ce82f855a1a5713333f8a1b6",
                "sha256": "3a27573dc191bced7d422941c303b115da5e301dc9fc92347577a52e4ecda55b"
            },
            "downloads": -1,
            "filename": "sphinx_notion-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "af280365ce82f855a1a5713333f8a1b6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5807,
            "upload_time": "2025-08-20T11:43:54",
            "upload_time_iso_8601": "2025-08-20T11:43:54.246908Z",
            "url": "https://files.pythonhosted.org/packages/a8/ab/9ca77c94ab06e5365ee3cf62aa27b957876232cb28db0a7baae4a32306dc/sphinx_notion-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-20 11:43:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ftnext",
    "github_project": "sphinx-notion",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sphinx-notion"
}