A small Sphinx extension to enable tags and archive in documentation such as for a blog.
A small Sphinx extension to enable tags and archive in documentation such as for a blog.
Table of Contents
pip install sphinx-nbblog
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.
I use Hatch, pyenv, and LunarVim
hatch run lvim
After installing the python versions with pyenv, run:
hatch run test:test
sphinx-nbblog is distributed under the terms of the MIT license.
This project is based on sphinx-tags
FAQs
A small Sphinx extension to enable tags and archive in documentation such as for a blog.
We found that sphinx-nbblog demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.