A small Sphinx extension to enable tags and archive in documentation such as for a blog.
Project description
Sphinx nbblog
A small Sphinx extension to enable tags and archive in documentation such as for a blog.
Table of Contents
Installation
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, pyenv, and LunarVim
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 license.
Notes
This project is based on sphinx-tags
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_nbblog-0.3.0.tar.gz.
File metadata
- Download URL: sphinx_nbblog-0.3.0.tar.gz
- Upload date:
- Size: 12.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.25.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
de07b3840e1a6318ad9f6f7d607c56f8dcdf55c7cd6f5132f60fc8b8c300ab28
|
|
| MD5 |
48846b532f91fd69f583a4cb5b739294
|
|
| BLAKE2b-256 |
b42de86c82eba38cf81726e91f3496e5edf7caad6c4a2abd849001ded984fd9f
|
File details
Details for the file sphinx_nbblog-0.3.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_nbblog-0.3.0-py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.25.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ab12b0870b8fd40ff7102dbe7701a58baa14389d761ad38f8f5ba3d4858700d
|
|
| MD5 |
8be5ddae0015ecea56f0c0e650faa04d
|
|
| BLAKE2b-256 |
89371c186cfc393639e35a7f5d724ea0198a36822bc2e5039d601a8f79d28f98
|
