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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx_nbblog-0.3.0.tar.gz
(12.6 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_nbblog-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ab12b0870b8fd40ff7102dbe7701a58baa14389d761ad38f8f5ba3d4858700d |
|
MD5 | 8be5ddae0015ecea56f0c0e650faa04d |
|
BLAKE2b-256 | 89371c186cfc393639e35a7f5d724ea0198a36822bc2e5039d601a8f79d28f98 |