Merge pull request #5 from sphinx-notes/rename-to-render

Rename to 'sphinxnotes.render'

Author: SilverRainZ

.cruft.json

@@ -5,14 +5,14 @@
   "context": {
     "cookiecutter": {
       "namespace": "sphinxnotes",
-      "name": "data",
-      "full_name": "sphinxnotes-data",
+      "name": "render",
+      "full_name": "sphinxnotes.render",
       "author": "Shengyu Zhang",
-      "description": "Use reStructuredText/markdown to define, constrain, render, and analyze data in Sphinx documentations",
+      "description": "A framework to define, constrain, and render data in Sphinx documentation",
       "version": "1.0a0",
       "github_owner": "sphinx-notes",
       "github_repo": "data",
-      "pypi_name": "sphinxnotes-data",
+      "pypi_name": "sphinxnotes.render",
       "pypi_owner": "SilverRainZ",
       "is_python_project": true,
       "python_version": "3.12",

.github/workflows/pypi.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: pypi
-      url: https://pypi.org/p/sphinxnotes-data
+      url: https://pypi.org/p/sphinxnotes.render
     permissions:
       id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
     steps:

.github/workflows/release.yml

@@ -15,4 +15,4 @@ jobs:
       - uses: ncipollo/release-action@v1
         with:
           body: |
-            Changelog: https://sphinx.silverrainz.me/data/changelog.html
+            Changelog: https://sphinx.silverrainz.me/render/changelog.html

README.rst

@@ -1,26 +1,26 @@
 .. This file is generated from sphinx-notes/cookiecutter.
    You need to consider modifying the TEMPLATE or modifying THIS FILE.
 
-================
-sphinxnotes-data
-================
+==================
+sphinxnotes.render
+==================
 
-.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/data/github-pages
-   :target: https://sphinx.silverrainz.me/data
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/render/github-pages
+   :target: https://sphinx.silverrainz.me/render
    :alt: Documentation Status
-.. |license| image:: https://img.shields.io/github/license/sphinx-notes/data
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/render
    :target: https://github.com/sphinx-notes/data/blob/master/LICENSE
    :alt: Open Source License
-.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-data.svg
-   :target: https://pypi.python.org/pypi/sphinxnotes-data
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes.render.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes.render
    :alt: PyPI Package
-.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-data
-   :target: https://pypistats.org/packages/sphinxnotes-data
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes.render
+   :target: https://pypistats.org/packages/sphinxnotes.render
    :alt: PyPI Package Downloads
 
 |docs| |license| |pypi| |download|
 
-Use reStructuredText/markdown to define, constrain, render, and analyze data in Sphinx documentations.
+A framework to define, constrain, and render data in Sphinx documentation.
 
 .. INTRODUCTION START 
    (MUST written in standard reStructuredText, without Sphinx stuff)
@@ -29,4 +29,4 @@ Use reStructuredText/markdown to define, constrain, render, and analyze data in
 
 Please refer to Documentation_ for more details.
 
-.. _Documentation: https://sphinx.silverrainz.me/data
+.. _Documentation: https://sphinx.silverrainz.me/render

docs/api.rst

@@ -0,0 +1,7 @@
+=============
+API Reference
+=============
+
+.. note:: WIP
+
+.. automodule:: sphinxnotes.render.pipeline

docs/conf.py

@@ -9,7 +9,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'sphinxnotes-data'
+project = 'sphinxnotes.render'
 author = 'Shengyu Zhang'
 copyright = "2025, " + author
 
@@ -63,7 +63,7 @@
 
 # The URL which points to the root of the HTML documentation.
 # It is used to indicate the location of document like canonical_url
-html_baseurl = 'https://sphinx.silverrainz.me/data'
+html_baseurl = 'https://sphinx.silverrainz.me/render'
 
 html_logo = html_favicon = '_static/sphinx-notes.png'
 
@@ -118,6 +118,9 @@
 import os
 import sys
 sys.path.insert(0, os.path.abspath('../src/sphinxnotes'))
-extensions.append('data')
+extensions.append('render')
 
 # CUSTOM CONFIGURATION
+
+_ = extensions.pop() # no need to load extension
+primary_domain = 'py'

docs/index.rst

@@ -1,24 +1,24 @@
 .. This file is generated from sphinx-notes/cookiecutter.
    You need to consider modifying the TEMPLATE or modifying THIS FILE.
 
-================
-sphinxnotes-data
-================
+==================
+sphinxnotes.render
+==================
 
-.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/data/github-pages?label=docs
-   :target: https://sphinx.silverrainz.me/data
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/render/github-pages?label=docs
+   :target: https://sphinx.silverrainz.me/render
    :alt: Documentation Status
-.. |license| image:: https://img.shields.io/github/license/sphinx-notes/data
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/render
    :target: https://github.com/sphinx-notes/data/blob/master/LICENSE
    :alt: Open Source License
-.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-data.svg
-   :target: https://pypistats.org/packages/sphinxnotes-data
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes.render.svg
+   :target: https://pypistats.org/packages/sphinxnotes.render
    :alt: PyPI Package
-.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-data
-   :target: https://pypi.python.org/pypi/sphinxnotes-data
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes.render
+   :target: https://pypi.python.org/pypi/sphinxnotes.render
    :alt: PyPI Package Downloads
 .. |github| image:: https://img.shields.io/badge/GitHub-181717?style=flat&logo=github&logoColor=white/
-   :target: https://github.com/sphinx-notes/data
+   :target: https://github.com/sphinx-notes/render
    :alt: GitHub Repository
 
 |docs| |license| |pypi| |download| |github|
@@ -28,74 +28,23 @@ Introduction
 
 .. INTRODUCTION START
 
-.. warning::
+A framework to define, constrain, and render data in Sphinx documentation.
 
-   PRE-RELEAST, DO NOT use it.
-
-   This extension provides the underlying functionality for `sphinxnotes-any`__.
+.. seealso:: `sphinxnotes-any`__ and `sphinxnotes-data`__ 
 
    __ https://sphinx.silverrainz.me/any/
-
-.. data:template::
-   :on: parsed
-
-   I am {{ name }}. I have the following attributes:
-
-   {% for k, v in attrs.items() %}
-   :{{ k }}: {{ v }}
-   {%- endfor %}
-
-   This document "{{ _doc.title }}" has {{ _doc.sections | length }} section(s).
-
-   {{ content }} 
-
-.. data:def:: Shengyu Zhang
-   :github: SilverRainZ
-   :homepage: https://silverrainz.me/
-
----
-
-.. data:template::
-   :debug:
-
-   builder: {{ _sphinx.builder.name }}
-
-:data:def+foo:`bar`
+   __ https://sphinx.silverrainz.me/data/
 
 .. INTRODUCTION END
 
 Getting Started
 ===============
 
-.. note::
-
-   We assume you already have a Sphinx documentation,
-   if not, see `Getting Started with Sphinx`_.
-
-
-First, downloading extension from PyPI:
-
-.. code-block:: console
-
-   $ pip install sphinxnotes-data
-
-
-Then, add the extension name to ``extensions`` configuration item in your
-:parsed_literal:`conf.py_`:
-
-.. code-block:: python
-
-   extensions = [
-             # …
-             'sphinxnotes.data',
-             # …
-             ]
-
-.. _Getting Started with Sphinx: https://www.sphinx-doc.org/en/master/usage/quickstart.html
-.. _conf.py: https://www.sphinx-doc.org/en/master/usage/configuration.html
-
 .. ADDITIONAL CONTENT START
 
+This extension is not intended to be used directly by Sphinx user.
+It is for Sphinx extension developer, please refer to :doc:`api`.
+
 .. ADDITIONAL CONTENT END
 
 Contents
@@ -104,6 +53,7 @@ Contents
 .. toctree::
    :caption: Contents
 
+   api
    changelog
 
 The Sphinx Notes Project

pyproject.toml

@@ -6,8 +6,8 @@
 # https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#declaring-project-metadata
 
 [project]
-name = "sphinxnotes-data"
-description = "Use reStructuredText/markdown to define, constrain, render, and analyze data in Sphinx documentations"
+name = "sphinxnotes.render"
+description = "A framework to define, constrain, and render data in Sphinx documentation"
 readme = "README.rst"
 license = "BSD-3-Clause"
 license-files = ["LICENSE"]
@@ -77,10 +77,10 @@ docs = [
 ]
 
 [project.urls]
-homepage = "https://sphinx.silverrainz.me/data"
-documentation = "https://sphinx.silverrainz.me/data"
+homepage = "https://sphinx.silverrainz.me/render"
+documentation = "https://sphinx.silverrainz.me/render"
 repository = "https://github.com/sphinx-notes/data"
-changelog = "https://sphinx.silverrainz.me/data/changelog.html"
+changelog = "https://sphinx.silverrainz.me/render/changelog.html"
 tracker = "https://github.com/sphinx-notes/data/issues"
 
 [build-system]