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.1.0.tar.gz
(12.5 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_nbblog-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c50126874b4b41d8e5847c1c21f94198ac35c3d270019ee44d7c1d6dc001714 |
|
MD5 | a13c7b48cd872bb442e2a329a3fc6c1a |
|
BLAKE2b-256 | 15185442379eaf6f2bc6820dfe9b39112a3f77f512323a742a50be2cd6f2e63b |