sphinxnotes-data

Introduction

Warning

PRE-RELEAST, DO NOT use it.

This extension provides the underlying functionality for sphinxnotes-any.

I am Shengyu Zhang. I have the following attributes:

github:

SilverRainZ

homepage:

https://silverrainz.me/

This document “None” has 4 section(s).

None

—

builder: html ^{Render Debug Report}

System Message: DEBUG/2 (/home/runner/work/data/data/docs/index.rst, line 63); backlink

Render Debug Report:

Raw data:

RawData(name='foo', attrs={}, content='bar')

Schema:

Schema(name=Field(etype=<class 'str'>,
                  ctype=None,
                  flags={'required': False, 'sep': None}),
       attrs={},
       content=Field(etype=<class 'str'>,
                     ctype=None,
                     flags={'required': False, 'sep': None}))

Parsed data:

ParsedData(name='foo', attrs={}, content='bar')

Extra context (just key):

['_markup', '_section', '_doc', '_sphinx', '_docutils']

Template:

builder: {{ _sphinx.builder.name }}

Rendered markup text:

builder: html

Rendered nodes (inline: True):

builder: html

Getting Started

Note

We assume you already have a Sphinx documentation, if not, see Getting Started with Sphinx.

First, downloading extension from PyPI:

$ pip install sphinxnotes-data

Then, add the extension name to extensions configuration item in your conf.py:

extensions = [
          # …
          'sphinxnotes.data',
          # …
          ]

Contents

Contents

• Change Log

The Sphinx Notes Project

The project is developed by Shengyu Zhang, as part of The Sphinx Notes Project.

The Sphinx Notes Project

• Home
• Blog
• PyPI