-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ litestar-org/type-lens@3b4725b 🚀
- Loading branch information
Showing
52 changed files
with
5,863 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
========= | ||
Changelog | ||
========= | ||
|
||
All commits to this project will be documented in this file. | ||
|
||
`Release [v0.1.0a1] - 2024-04-26 <https://github.com/litestar-org/type-lens/releases/tag/v0.1.0a1>`_ | ||
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ||
* `See All commits in v0.1.0a1 <https://github.com/litestar-org/type-lens/commits/v0.1.0a1>`_ | ||
|
||
`0e209be <https://github.com/litestar-org/type-lens/commit/0e209be1dc0bf99a0163ec4cdc15e36e4d21eb2b>`_ ... `567f49a <https://github.com/litestar-org/type-lens/commit/567f49ae117ff5d3619f857cbf986d454ef7e9fa>`_ | `See diff for 0.1.0a1 <https://github.com/litestar-org/type-lens/compare/0e209be1dc0bf99a0163ec4cdc15e36e4d21eb2b...567f49ae117ff5d3619f857cbf986d454ef7e9fa>`_ | ||
|
||
Bug Fixes | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
* (`6405898 <https://github.com/litestar-org/type-lens/commit/64058981550b0ca41538fe8a706cd782a885dc4d>`_) - Add ParameterView to pkg ns (Peter Schutt) | ||
|
||
Documentation | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
* (`3d80638 <https://github.com/litestar-org/type-lens/commit/3d806380f3e9b6b6d2a02c0bfbca866701f7df8a>`_) - Move to litestar (Jacob Coffee) | ||
* (`bea1211 <https://github.com/litestar-org/type-lens/commit/bea12110642f52e7df44ab0a088cdc63a618915c>`_) - Fix discord link (Jacob Coffee) | ||
* (`55ef5f6 <https://github.com/litestar-org/type-lens/commit/55ef5f6b161ec20c7691e656ea525fc61d71c8a5>`_) - Add pages (Jacob Coffee) | ||
* (`14b0898 <https://github.com/litestar-org/type-lens/commit/14b08987f33a88f56a1a6e4084695cb74c5e2ae8>`_) - Update changelog, add filler content (Jacob Coffee) | ||
* (`567f49a <https://github.com/litestar-org/type-lens/commit/567f49ae117ff5d3619f857cbf986d454ef7e9fa>`_) - Fix version (Jacob Coffee) | ||
|
||
Refactor | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
* (`105043a <https://github.com/litestar-org/type-lens/commit/105043af379af5c8f8670f276767e9c0ac830b1c>`_) - Better Empty type (Peter Schutt) | ||
* (`2076afe <https://github.com/litestar-org/type-lens/commit/2076afe75f4a1a0c23d50e245a27bdd388cfaa1e>`_) - Use plain old python classes (Peter Schutt) | ||
|
||
Ci | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
* (`0da8b24 <https://github.com/litestar-org/type-lens/commit/0da8b245d3bea78b3caad01a1c319f79bbb13f36>`_) - Apply pre-commit (Jacob Coffee) | ||
|
||
Type Lens Changelog |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
:orphan: | ||
|
||
.. include:: ../CONTRIBUTING.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
========= | ||
Type Lens | ||
========= | ||
|
||
.. warning:: Pre-Release Alpha Stage | ||
|
||
Please note that ``type-lens`` is currently in a pre-release alpha stage of development. This means the library is still | ||
under active development, and its API is subject to change. We encourage developers to experiment with ``type-lens`` and | ||
provide feedback, but we recommend against using it in production environments until a stable release is available. | ||
|
||
Please see :doc:`releases` for more information on the stability policy. | ||
|
||
Introduction | ||
============ | ||
|
||
The ``type-lens`` library is cool. | ||
|
||
Purpose | ||
======= | ||
|
||
``type-lens`` is built to do stuff. | ||
|
||
.. toctree:: | ||
:titlesonly: | ||
:caption: Documentation | ||
:hidden: | ||
|
||
usage/index | ||
reference/index | ||
|
||
.. toctree:: | ||
:titlesonly: | ||
:caption: Development | ||
:hidden: | ||
|
||
changelog | ||
contribution-guide | ||
Available Issues <https://github.com/search?q=user%3Alitestar-org+state%3Aopen+label%3A%22good+first+issue%22+++no%3Aassignee+repo%3A%22type-lens%22&type=issues> | ||
Code of Conduct <https://github.com/litestar-org/.github?tab=coc-ov-file#readme> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
============= | ||
API Reference | ||
============= | ||
|
||
The API reference is automatically generated from the docstrings in the code, and is useful for | ||
finding out what methods and attributes are available for a given class. The API reference is | ||
divided into several sections, each of which is listed below. | ||
|
||
.. note:: Private methods and attributes are not included in the API reference. | ||
|
||
Available API References | ||
------------------------ | ||
|
||
.. toctree:: | ||
:titlesonly: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
:orphan: | ||
|
||
================== | ||
Type Lens Releases | ||
================== | ||
|
||
Version Numbering | ||
----------------- | ||
|
||
This library follows the `Semantic Versioning standard <https://semver.org/>`_, using the ``<major>.<minor>.<patch>`` | ||
schema: | ||
|
||
**Major** | ||
Backwards incompatible changes have been made | ||
|
||
**Minor** | ||
Functionality was added in a backwards compatible manner | ||
|
||
**Patch** | ||
Bugfixes were applied in a backwards compatible manner | ||
|
||
Pre-release Versions | ||
++++++++++++++++++++ | ||
|
||
Before a new major release, we will make ``alpha``, ``beta``, and release candidate (``rc``) releases, numbered as | ||
``<major>.<minor>.<patch><release_type><number>``. For example, ``2.0.0alpha1``, ``2.0.0beta1``, ``2.0.0rc1``. | ||
|
||
- ``alpha`` | ||
Early developer preview. Features may not be complete and breaking changes can occur. | ||
|
||
- ``beta`` | ||
More stable preview release. Feature complete, no major breaking changes expected. | ||
|
||
- ``rc`` | ||
Release candidate. Feature freeze, only bugfixes until final release. | ||
Suitable for testing migration to the upcoming major release. | ||
|
||
Long-term Support Releases (LTS) | ||
-------------------------------- | ||
|
||
Major releases are designated as LTS releases for the life of that major release series. | ||
These releases will receive bugfixes for a guaranteed period of time as defined in | ||
`Supported Versions <#supported-versions>`_. | ||
|
||
Deprecation Policy | ||
------------------ | ||
|
||
When a feature is going to be removed, a deprecation warning will be added in a **minor** release. | ||
The feature will continue to work for all releases in that major series, and will be removed in the next major release. | ||
|
||
For example, if a deprecation warning is added in ``1.1``, the feature will work throughout all ``1.x`` releases, | ||
and be removed in ``2.0``. | ||
|
||
Supported Versions | ||
------------------ | ||
|
||
At any time, the Litestar organization will actively support: | ||
|
||
- The current major release series | ||
- The previous major release series | ||
- Any other designated LTS releases (Special cases) | ||
|
||
For example, if the current release is ``2.0``, we will actively support ``2.x`` and ``1.x``. | ||
When ``3.0`` is released, we will drop support for ``1.x``. | ||
|
||
Bugfixes will be applied to the current major release, and selectively backported to older | ||
supported versions based on severity and feasibility. | ||
|
||
Release Process | ||
--------------- | ||
|
||
Each major release cycle consists of a few phases: | ||
|
||
#. **Planning**: Define roadmap, spec out major features. Work should begin on implementation. | ||
#. **Development**: Active development on planned features. Ends with an alpha release and branch of ``A.B.x`` | ||
branch from `main`. | ||
#. **Bugfixes**: Only bugfixes, no new features. Progressively release beta, release candidates. | ||
Feature freeze at RC. Become more selective with backports to avoid regressions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
===== | ||
Usage | ||
===== | ||
|
||
The usage documentation is for end users of the library. It provides an high-level | ||
overview of what features are available and how to use them. | ||
|
||
|
||
.. toctree:: | ||
:titlesonly: | ||
|
||
placeholder |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
=========== | ||
Placeholder | ||
=========== | ||
|
||
.. todo:: You've stumbled upon a beautiful work in progress! Please excuse our unfinished work and check | ||
back soon for updates. |
1 change: 1 addition & 0 deletions
1
_sphinx_design_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
var sd_labels_by_text = {}; | ||
|
||
function ready() { | ||
const li = document.getElementsByClassName("sd-tab-label"); | ||
for (const label of li) { | ||
syncId = label.getAttribute("data-sync-id"); | ||
if (syncId) { | ||
label.onclick = onLabelClick; | ||
if (!sd_labels_by_text[syncId]) { | ||
sd_labels_by_text[syncId] = []; | ||
} | ||
sd_labels_by_text[syncId].push(label); | ||
} | ||
} | ||
} | ||
|
||
function onLabelClick() { | ||
// Activate other inputs with the same sync id. | ||
syncId = this.getAttribute("data-sync-id"); | ||
for (label of sd_labels_by_text[syncId]) { | ||
if (label === this) continue; | ||
label.previousElementSibling.checked = true; | ||
} | ||
window.localStorage.setItem("sphinx-design-last-tab", syncId); | ||
} | ||
|
||
document.addEventListener("DOMContentLoaded", ready, false); |
Oops, something went wrong.