sphinx-nbblog 0.3.0

A small Sphinx extension to enable tags and archive in documentation such as for a blog.

Sphinx nbblog

A small Sphinx extension to enable tags and archive in documentation such as for a blog.

---

Table of Contents

• Installation
• Usage
• Development
• License
• Notes

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