chore: Still use the 'any' prefix

SilverRainZ · SilverRainZ · commit 4acec08d283d · 2026-01-30T01:06:39.000+08:00
diff --git a/docs/_schemas/dog2.py b/docs/_schemas/dog2.py
@@ -9,8 +9,8 @@
     },
     'templates': {
         'obj': dedent("""
-            :Breed: :obj:dog.breed:`{{ breed }}`
-            :Colors: {% for c in color %}:obj:dog.color:`{{ c }}` {% endfor %}"""),
+            :Breed: :any:dog.breed:`{{ breed }}`
+            :Colors: {% for c in color %}:any:dog.color:`{{ c }}` {% endfor %}"""),
         'ref': '🐕{{ title }}',
     },
 }
diff --git a/docs/_schemas/dogs.rst b/docs/_schemas/dogs.rst
@@ -6,23 +6,23 @@ Dogs
 
 This pages describe some Town Dogs [#]_ in Terraria [#]_:
 
-.. obj:dog:: Arthur
+.. any:dog:: Arthur
    :breed: Labrador
    :color: Golden
 
-.. obj:dog:: Bitsy
+.. any:dog:: Bitsy
    :breed: Labrador
    :color: Golden
 
-.. obj:dog:: Doug
+.. any:dog:: Doug
    :breed: Pit Bull
    :color: Brown White
 
-.. obj:dog:: Ginger
+.. any:dog:: Ginger
    :breed: Pit Bull
    :color: Brown White
 
-.. obj:dog:: Hachiko
+.. any:dog:: Hachiko
    :breed: Husky
    :color: Black White
 
diff --git a/docs/_schemas/indiana-dog.txt b/docs/_schemas/indiana-dog.txt
@@ -1,3 +1,3 @@
-.. obj:dog:: Indiana
+.. any:dog:: Indiana
    :breed: Husky
    :color: Black White
diff --git a/docs/_schemas/mimi.txt b/docs/_schemas/mimi.txt
@@ -1,4 +1,4 @@
 .. rubric:: mimi
 
-.. obj:cat:: _
+.. any:cat:: _
    :id: 2
diff --git a/docs/_schemas/nyan-cat.txt b/docs/_schemas/nyan-cat.txt
@@ -1,10 +1,10 @@
-.. obj:cat:: Nyan Cat
+.. any:cat:: Nyan Cat
              Nyan_Cat
    :id: 1
    :color: pink gray
    :picture: _images/nyan-cat.gif
 
-   :obj:cat:`Nyan Cat` is the name of a YouTube video uploaded in April 2011,
+   :any:cat:`Nyan Cat` is the name of a YouTube video uploaded in April 2011,
    which became an internet meme. The video merged a Japanese pop song with
    an animated cartoon cat with a Pop-Tart for a torso, flying through space,
    and leaving a rainbow trail behind it. The video ranked at number 5 on
diff --git a/docs/conf.py b/docs/conf.py
@@ -122,8 +122,8 @@
 # For locating packages under _schemas/.
 sys.path.insert(0, os.path.abspath('.'))
 
-obj_domain_name = 'obj'
-obj_type_defines = {
+any_domain_name = 'obj'
+any_object_types = {
     'version': {
         'schema': {
             'attrs': {
@@ -172,4 +172,4 @@
     'dog': __import__("_schemas.dog2").dog2.dog,
 }
 
-primary_domain = obj_domain_name
+primary_domain = any_domain_name
diff --git a/docs/conf.rst b/docs/conf.rst
@@ -4,10 +4,22 @@ Configuration
 
 The extension provides the following configuration:
 
-.. autoconfval:: obj_domain_name
+.. autoconfval:: any_domain_name
 
-.. autoconfval:: obj_type_defines
+   The name of the domain.
 
-.. autoconfval:: obj_domain_dump
+.. autoconfval:: any_object_types
 
-.. autoconfval:: obj_auto_obj
+   A dictionary ``dict[str, objdef]`` of object type definitions.
+
+   The ``str`` key is the object type;
+   The ``objdef`` vaule is a ``dict``,
+   please refer to :ref:`writing-objdef` for more details.
+
+.. autoconfval:: any_domain_dump
+
+   Whether dump domain data to :file:`$DOCTREE_DIR/$OBJ_DOMAIN_NAME-objects.json`.
+
+   The ``$DOCTREE_DIR`` is usually :file:`_build/doctrees/`.
+   The ``$OBJ_DOMAIN_NAME`` refers value of :confval:`any_domain_name`.
+   (By default, the path is :file:`_build/doctrees/obj-objects.json`)'.
diff --git a/docs/index.rst b/docs/index.rst
@@ -71,28 +71,28 @@ Add the such a "cat" dict in your ``conf.py``:
 
 .. literalinclude:: /_schemas/cat.py
    
-And add it to the :confval:`obj_type_defines` confval:
+And add it to the :confval:`any_object_types` confval:
 
 .. code:: python
 
-   obj_type_defines = {
+   any_object_types = {
       'cat': cat,
    }
 
-Then you can document a cat using the :rst:dir:`obj:cat` directive:
+Then you can document a cat using the :rst:dir:`any:cat` directive:
 
 .. example::
    :style: grid
 
-   .. obj:cat:: mimi
+   .. any:cat:: mimi
       :color: black
 
-And reference a the cat with :rst:role:`obj:cat`:
+And reference a the cat with :rst:role:`any:cat`:
 
 .. example::
    :style: grid
 
-   Hi :obj:cat:`mimi`! I am here!
+   Hi :any:cat:`mimi`! I am here!
 
 Please refer to :doc:`usage` for more details.
 
diff --git a/docs/tips.rst b/docs/tips.rst
@@ -5,7 +5,7 @@ Tips
 Omit Domain Name
 ================
 
-You can omit the prefixed domain name in directives and roles by setting the ``primary_domain`` to your :confval:`obj_domain_name` in :file:`conf.py`. For example, you can use ``.. cat::`` rather than ``.. obj:cat::``.
+You can omit the prefixed domain name in directives and roles by setting the ``primary_domain`` to your :confval:`any_domain_name` in :file:`conf.py`. For example, you can use ``.. cat::`` rather than ``.. any:cat::``.
 
 Documenting Section and Documentation
 =====================================
@@ -52,16 +52,16 @@ When we see the breed of Indiana is "Husky", we may want to see what other huski
 .. literalinclude:: /_schemas/dog2.py
    :language: python
 
-For field breed, its value is a string, so we simpily wrap value in to a ``obj:dog.breed`` role, In this case it create a reference to all Husky dog.
+For field breed, its value is a string, so we simpily wrap value in to a ``any:dog.breed`` role, In this case it create a reference to all Husky dog.
 
-For field color, its value is a string list, we have to iterate it and wrap element to to a ``obj:dog.color`` role, In this case it create a reference to all Black dog and White dog.
+For field color, its value is a string list, we have to iterate it and wrap element to to a ``any:dog.color`` role, In this case it create a reference to all Black dog and White dog.
 
 The rendered reStructuredText looks like this:
 
 .. code-block:: rst
 
-   :Breed: :obj:dog.breed:`Husky`
-   :Colors: :obj:dog.color:`Blac.. obj:dog.color:`White`
+   :Breed: :any:dog.breed:`Husky`
+   :Colors: :any:dog.color:`Blac.. any:dog.color:`White`
 
 The rendered object description:
 
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -23,7 +23,7 @@ Documenting Object
 
 Once a schema created, the corresponding :ref:`directives`, :ref:`roles` and :ref:`indices` will be generated. You can use them to descibe, reference and index object in your documentation.
 
-For the convenience, we use default domain name "any", and we assume that we have the following schema with in :obj:confval:`any_schemas`:
+For the convenience, we use default domain name "any", and we assume that we have the following schema with in :any:confval:`any_schemas`:
 
 .. _directives:
 
@@ -35,10 +35,10 @@ Directives
 Object Description
 ~~~~~~~~~~~~~~~~~~
 
-The aboved schema created a Directive_ named with "``domain``:\ ``objtype``" (In this case, it is ``obj:cat``) for descibing object(INC, it is cat🐈).
+The aboved schema created a Directive_ named with "``domain``:\ ``objtype``" (In this case, it is ``any:cat``) for descibing object(INC, it is cat🐈).
 
 Arguments
-   Arguments are used to specify the :obj:tmplvar:`name` of the object. The number argument is depends on the name :py:class:`any.Field` of Schema.
+   Arguments are used to specify the :any:tmplvar:`name` of the object. The number argument is depends on the name :py:class:`any.Field` of Schema.
 
    - A ``None`` field means no argument is required
    - For a non-``None`` Field, see :py:attr:`any.Field` for more details
@@ -47,7 +47,7 @@ Arguments
 
    Specially, If first argument is ``_`` (underscore), the directive must be located after a `Section Title`_, the text of section title is the real first argument.
 
-   In this case, the ``obj:cat`` directive accepts multiple argument split by newline.
+   In this case, the ``any:cat`` directive accepts multiple argument split by newline.
 
 Options
    All attributes defined in schema are converted to options of directive. Further, they will available in various :ref:`Templates <writing-template>`.
@@ -61,7 +61,7 @@ Options
    In this case, the directive has three options: ``id``, ``color`` and ``picture``.
 
 Content
-   Content is used to specify the :obj:tmplvar:`content` of the object.
+   Content is used to specify the :any:tmplvar:`content` of the object.
 
    - A ``None`` field means no content is required
    - For a non-``None`` Field, see :py:attr:`any.Field` for more details
@@ -94,26 +94,26 @@ Same to :ref:`sphinx:xref-syntax`, explicit title ``:role:`title <target>``` is
 General Reference
 ~~~~~~~~~~~~~~~~~
 
-The aboved schema created a role named with "``domain``-\ ``objtype``" (In this case, it is ``obj:cat``) for creating a reference to :ref:`object-description`. The interpreted text can be value of *any referenceable field*.
+The aboved schema created a role named with "``domain``-\ ``objtype``" (In this case, it is ``any:cat``) for creating a reference to :ref:`object-description`. The interpreted text can be value of *any referenceable field*.
 
 =================== =================================== ========================
-Reference by name   ``:obj:cat:`Nyan Cat```             :obj:cat:`Nyan Cat`
-By another name     ``:obj:cat:`Nyan_Cat```             :obj:cat:`Nyan_Cat`
-By ID               ``:obj:cat:`1```                    :obj:cat:`1`
-Explicit title      ``:obj:cat:`This cat <Nyan Cat>```  :obj:cat:`This cat <Nyan Cat>`
-A nonexistent cat   ``:obj:cat:`mimi```                 :obj:cat:`mimi`
+Reference by name   ``:any:cat:`Nyan Cat```             :any:cat:`Nyan Cat`
+By another name     ``:any:cat:`Nyan_Cat```             :any:cat:`Nyan_Cat`
+By ID               ``:any:cat:`1```                    :any:cat:`1`
+Explicit title      ``:any:cat:`This cat <Nyan Cat>```  :any:cat:`This cat <Nyan Cat>`
+A nonexistent cat   ``:any:cat:`mimi```                 :any:cat:`mimi`
 =================== =================================== ========================
 
 Field-Specific Reference
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-Role "``domain``-\ ``objtype``.\ ``field``" will be created for all referenceable Fields (In this case, it is ``obj:cat.name``, ``any:cat.id`` and ``any:cat.color``).
+Role "``domain``-\ ``objtype``.\ ``field``" will be created for all referenceable Fields (In this case, it is ``any:cat.name``, ``any:cat.id`` and ``any:cat.color``).
 
 These roles also create reference to :ref:`object-description`. But the interpreted text must be value of field in role's name.
 
 =================== =============================== ============================
-Reference by name   ``:obj:cat.name:`Nyan Cat```    :obj:cat.name:`Nyan Cat`
-By ID               ``:obj:cat.id:`1```             :obj:cat.id:`1`
+Reference by name   ``:any:cat.name:`Nyan Cat```    :any:cat.name:`Nyan Cat`
+By ID               ``:any:cat.id:`1```             :any:cat.id:`1`
 =================== =============================== ============================
 
 .. _indices:
@@ -174,12 +174,12 @@ Reference Template has two various variants:
 Missing Reference Template
    Applied when the reference is missing.
 
-   .. hint:: In this template, only variables :obj:tmplvar:`objtype` and :obj:tmplvar:`title`  are available.
+   .. hint:: In this template, only variables :any:tmplvar:`objtype` and :any:tmplvar:`title`  are available.
 
 Ambiguous Reference Template
    Applied when the reference is ambiguous.
 
-   .. hint:: In this template, only variables :obj:tmplvar:`objtype` and :obj:tmplvar:`title`  are available.
+   .. hint:: In this template, only variables :any:tmplvar:`objtype` and :any:tmplvar:`title`  are available.
 
 Variables
 ---------
@@ -192,25 +192,25 @@ All attributes defined in schema are available as variables in template. Note th
 
 Beside, there are some special variable:
 
-.. obj:tmplvar:: objtype
+.. any:tmplvar:: objtype
    :type: str
    :conf: TYPE_KEY
 
    Type of object.
 
-.. obj:tmplvar:: name
+.. any:tmplvar:: name
    :type: Union[None,str,List[str]]
    :conf: NAME_KEY
 
    Name of object.
 
-.. obj:tmplvar:: content
+.. any:tmplvar:: content
    :type: Union[None,str,List[str]]
    :conf: CONTENT_KEY
 
    Content of object.
 
-.. obj:tmplvar:: title
+.. any:tmplvar:: title
    :type: str
    :conf: TITLE_KEY
 
diff --git a/src/sphinxnotes/any/__init__.py b/src/sphinxnotes/any/__init__.py
@@ -63,21 +63,21 @@ def _validate_objtype_defines_dict(d: dict, config: Config) -> ObjTypeDef:
         debug=objdef['debug'],
     )
 
-    auto = objdef['auto'] or config.obj_auto_obj
+    auto = objdef['auto'] or config.git_object_auto
 
     return ObjTypeDef(schema=schema, templates=tmpls, auto=auto)
 
 
 def _config_inited(app: Sphinx, config: Config) -> None:
-    ObjDomain.name = config.obj_domain_name
+    ObjDomain.name = config.any_domain_name
 
-    for objtype, objdef in app.config.obj_type_defines.items():
+    for objtype, objdef in app.config.any_object_types.items():
         # TODO: check ":" in objtype to support multiple domain
         try:
             objtypedef = _validate_objtype_defines_dict(objdef, config)
         except (DictSchemaError, ValueError) as e:
             raise ConfigError(
-                f'Validating obj_type_defines[{repr(objtype)}]: {e}'
+                f'Validating any_object_types[{repr(objtype)}]: {e}'
             ) from e
         ObjDomain.add_objtype(objtype, objtypedef)
 
@@ -90,20 +90,9 @@ def setup(app: Sphinx):
 
     app.setup_extension('sphinxnotes.data')
 
-    app.add_config_value(
-        'obj_domain_name', 'obj', 'env', types=str, description='Name of the domain'
-    )
-    app.add_config_value(
-        'obj_type_defines',
-        {},
-        'env',
-        types=dict,
-        description='A dictionary ``dict[str, objdef]`` of object type definitions. '
-        'The ``str`` key is the object type; '
-        'The ``objdef`` vaule is also a ``dict``, '
-        'please refer to :ref:`writing-objdef` for more details.',
-    )
-    app.add_config_value('obj_auto_obj', True, 'env', types=bool)
+    app.add_config_value('any_domain_name', 'obj', 'env', types=str)
+    app.add_config_value('any_object_types', {}, 'env', types=dict)
+    app.add_config_value('git_object_auto', True, 'env', types=bool)
 
     app.connect('config-inited', _config_inited)
 
diff --git a/src/sphinxnotes/any/datetime.py b/src/sphinxnotes/any/datetime.py
@@ -70,11 +70,11 @@ def __reduce__(self):
 
 
 def _config_inited(app: Sphinx, config: Config) -> None:
-    DATE_FMTS.extend(config.obj_date_fmts)
+    DATE_FMTS.extend(config.any_date_fmts)
 
 
 def setup(app: Sphinx) -> None:
-    app.add_config_value('obj_date_fmts', ['%Y-%m-%d', '%Y-%m', '%Y'], '', types=list)
+    app.add_config_value('any_date_fmts', ['%Y-%m-%d', '%Y-%m', '%Y'], '', types=list)
     app.connect('config-inited', _config_inited)
 
 
diff --git a/src/sphinxnotes/any/domain.py b/src/sphinxnotes/any/domain.py
diff --git a/src/sphinxnotes/any/dump.py b/src/sphinxnotes/any/dump.py
diff --git a/src/sphinxnotes/any/obj.py b/src/sphinxnotes/any/obj.py
