| Name | sphinx-nbblog JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A small Sphinx extension to enable tags and archive in documentation such as for a blog. |
| upload_time | 2023-10-24 18:34:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
blog
extension
sphinx
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Sphinx nbblog
A small [Sphinx](https://www.sphinx-doc.org) extension to enable tags and archive in documentation such as for a blog.
[](https://pypi.org/project/sphinx-nbblog)
[](https://pypi.org/project/sphinx-nbblog)
-----
**Table of Contents**
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [License](#license)
- [Notes](#notes)
## Installation
```console
pip install sphinx-nbblog
```
## Usage
Add `sphinx-nbblog` somewhere in the `extensions` list in `conf.py`
```
extensions = [
...
"sphinx_nbblog",
]
```
In an .rst file or in a .ipynb raw rst cell:
```
.. nbblog::
:abstract: what is this about
:date: 2023-09-23
:tags: yes, no, maybe
```
In another file, such as archive.rst
```
Archive
=======
.. archive::
```
The abstract currently does nothing but at some point I will
probably make it visible in the archive page.
## Development
I use [Hatch](https://hatch.pypa.io/latest/), [pyenv](https://github.com/pyenv/pyenv), and [LunarVim](https://www.lunarvim.org/)
```
hatch run lvim
```
### Test
After installing the python versions with pyenv, run:
```
hatch run test:test
```
## License
`sphinx-nbblog` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
## Notes
This project is based on [sphinx-tags](https://github.com/melissawm/sphinx-tags)
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-nbblog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "blog,extension,sphinx",
"author": null,
"author_email": "bjorns <bjorn@tauganet.io>",
"download_url": "https://files.pythonhosted.org/packages/b9/84/48f7e2043319971ce2bcda9c3c49a4ef768cf70698a645d3d93a952b39ca/sphinx_nbblog-0.1.0.tar.gz",
"platform": null,
"description": "# Sphinx nbblog\n\nA small [Sphinx](https://www.sphinx-doc.org) extension to enable tags and archive in documentation such as for a blog.\n\n[](https://pypi.org/project/sphinx-nbblog)\n[](https://pypi.org/project/sphinx-nbblog)\n\n-----\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Development](#development)\n- [License](#license)\n- [Notes](#notes)\n\n## Installation\n\n```console\npip install sphinx-nbblog\n```\n\n## Usage\n\nAdd `sphinx-nbblog` somewhere in the `extensions` list in `conf.py`\n\n```\nextensions = [\n ...\n \"sphinx_nbblog\",\n]\n```\n\nIn an .rst file or in a .ipynb raw rst cell:\n\n```\n.. nbblog::\n :abstract: what is this about\n :date: 2023-09-23\n :tags: yes, no, maybe\n```\n\nIn another file, such as archive.rst\n\n```\nArchive\n=======\n\n.. archive::\n```\n\nThe abstract currently does nothing but at some point I will\nprobably make it visible in the archive page.\n\n\n## Development\n\nI use [Hatch](https://hatch.pypa.io/latest/), [pyenv](https://github.com/pyenv/pyenv), and [LunarVim](https://www.lunarvim.org/)\n\n```\nhatch run lvim\n```\n\n\n### Test\n\nAfter installing the python versions with pyenv, run:\n\n```\nhatch run test:test\n```\n\n\n## License\n\n`sphinx-nbblog` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n\n\n## Notes\n\nThis project is based on [sphinx-tags](https://github.com/melissawm/sphinx-tags)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A small Sphinx extension to enable tags and archive in documentation such as for a blog.",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://codeberg.org/bjorns/Sphinx-nbblog",
"Homepage": "https://codeberg.org/bjorns/Sphinx-nbblog",
"Issues": "https://codeberg.org/bjorns/Sphinx-nbblog/issues",
"Source": "https://codeberg.org/bjorns/Sphinx-nbblog"
},
"split_keywords": [
"blog",
"extension",
"sphinx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "15185442379eaf6f2bc6820dfe9b39112a3f77f512323a742a50be2cd6f2e63b",
"md5": "a13c7b48cd872bb442e2a329a3fc6c1a",
"sha256": "4c50126874b4b41d8e5847c1c21f94198ac35c3d270019ee44d7c1d6dc001714"
},
"downloads": -1,
"filename": "sphinx_nbblog-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a13c7b48cd872bb442e2a329a3fc6c1a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8300,
"upload_time": "2023-10-24T18:34:30",
"upload_time_iso_8601": "2023-10-24T18:34:30.277504Z",
"url": "https://files.pythonhosted.org/packages/15/18/5442379eaf6f2bc6820dfe9b39112a3f77f512323a742a50be2cd6f2e63b/sphinx_nbblog-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b98448f7e2043319971ce2bcda9c3c49a4ef768cf70698a645d3d93a952b39ca",
"md5": "bd0d60c7425cc1f4c73b0585dc63019a",
"sha256": "127987142810fcf67556ac8a9d15672ea45c0d530cf3d3a09f5a9f12d913439f"
},
"downloads": -1,
"filename": "sphinx_nbblog-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "bd0d60c7425cc1f4c73b0585dc63019a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12483,
"upload_time": "2023-10-24T18:34:32",
"upload_time_iso_8601": "2023-10-24T18:34:32.236089Z",
"url": "https://files.pythonhosted.org/packages/b9/84/48f7e2043319971ce2bcda9c3c49a4ef768cf70698a645d3d93a952b39ca/sphinx_nbblog-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-24 18:34:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "bjorns",
"codeberg_project": "Sphinx-nbblog",
"lcname": "sphinx-nbblog"
}
