Metadata-Version: 2.4
Name: sphinx-refs-alias
Version: 2.0.0
Summary: Add support alias for reference.
Author-email: Ярыкин Евгений <pypi@zedzhen.ru>
License: The zlib/libpng License
        
        Copyright (c) 2026 Ярыкин Евгений
        
        This software is provided 'as-is', without any express or implied
        warranty. In no event will the authors be held liable for any damages
        arising from the use of this software.
        
        Permission is granted to anyone to use this software for any purpose,
        including commercial applications, and to alter it and redistribute it
        freely, subject to the following restrictions:
        
        1. The origin of this software must not be misrepresented; you must not
           claim that you wrote the original software. If you use this software
           in a product, an acknowledgement in the product documentation would be
           appreciated but is not required.
        2. Altered source versions must be plainly marked as such, and must not be
           misrepresented as being the original software.
        3. This notice may not be removed or altered from any source distribution.
        
Project-URL: source, https://github.com/zedzhen/sphinx-refs-alias
Classifier: Framework :: Sphinx :: Extension
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx<10,>=8
Provides-Extra: dev
Requires-Dist: black~=26.5; extra == "dev"
Requires-Dist: isort~=8.0; extra == "dev"
Requires-Dist: build==1.5.*; extra == "dev"
Requires-Dist: pre-commit~=4.6; extra == "dev"
Dynamic: license-file

Add support alias for reference.

## Configs
`reference_aliases: dict[str, str | tuple[str, str | None]]`

The key is an alias.

If the value is a string, then it is equivalent to a tuple `(value, None)`.

If the value is a tuple:
* `value[0]` is the real name
* `value[1]` (if is not None) displayed text
