Skip to content

Commit

Permalink
docs: Fix some missing references (#2414)
Browse files Browse the repository at this point in the history
Fix some missing references and formatting

Signed-off-by: Janek Nouvertné <[email protected]>
  • Loading branch information
provinzkraut authored Oct 7, 2023
1 parent 0870bdf commit 2db93dd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
5 changes: 4 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,12 +220,15 @@ Creating a new release
----------------------

1. Increment the version in ``pyproject.toml`` according to the `versioning scheme <https://litestar.dev/about/litestar-releases#version-numbering>`_
.. note:: The version should follow `semantic versioning <https://semver.org/>`_ and `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.
.. note::
The version should follow `semantic versioning <https://semver.org/>`_ and `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.

2. Commit and push.
2. `Draft a new release <https://github.com/litestar-org/litestar/releases/new>`_ on GitHub

* Use ``vMAJOR.MINOR.PATCH`` (e.g. ``v1.2.3``) as both the tag and release title
* Fill in the release description. You can use the "Generate release notes" function to get a draft for this

3. Commit your changes and push to ``main``
4. Publish the release
5. Go to `Actions <https://github.com/litestar-org/litestar/actions>`_ and approve the release workflow
Expand Down
8 changes: 6 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,9 @@
(PY_METH, "litestar.dto.factory.DTOData.create_instance"),
(PY_METH, "litestar.dto.interface.DTOInterface.data_to_encodable_type"),
(PY_CLASS, "advanced_alchemy.repository.typing.ModelT"),
(PY_CLASS, "advanced_alchemy.config.common.EngineT"),
(PY_CLASS, "advanced_alchemy.config.common.SessionT"),
(PY_OBJ, "advanced_alchemy.config.common.SessionMakerT"),
(PY_OBJ, "advanced_alchemy.config.common.ConnectionT"),
(PY_CLASS, "advanced_alchemy.extensions.litestar.plugins._slots_base.SlotsBase"),
(PY_CLASS, "advanced_alchemy.config.EngineConfig"),
(PY_CLASS, "advanced_alchemy.extensions.litestar.plugins.SQLAlchemyPlugin"),
(PY_CLASS, "advanced_alchemy.extensions.litestar.plugins.SQLAlchemySerializationPlugin"),
Expand All @@ -156,6 +157,7 @@
(PY_CLASS, "advanced_alchemy.types.BigIntIdentity"),
(PY_FUNC, "sqlalchemy.get_engine"),
(PY_ATTR, "advanced_alchemy.repository.AbstractAsyncRepository.id_attribute"),
(PY_OBJ, "litestar.template.base.T_co"),
("py:exc", "RepositoryError"),
]

Expand All @@ -182,6 +184,8 @@
(PY_RE, r"litestar\.pagination\.C"),
(PY_RE, r"multidict\..*"),
(PY_RE, r"advanced_alchemy.*\.T"),
(PY_RE, r"advanced_alchemy\.config.common\.EngineT"),
(PY_RE, r"advanced_alchemy\.config.common\.SessionT"),
]

# Warnings about missing references to those targets in the specified location will be ignored.
Expand Down

0 comments on commit 2db93dd

Please sign in to comment.