Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update doc versions, remove 0.9.5 doc links

Browse source
This commit is contained in:
Griatch 2023-06-10 08:08:07 +02:00
parent d3067d34c9
commit 798e5d8ff4
7 changed files with 48 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

14
CHANGELOG.md
View file

@ -1,11 +1,16 @@
# Changelog # Changelog
## Main branch ## Evennia 2.0
June 10, 2023
- **Possible backwards incompatibility**: Updated contrib `ExtendedRoom` now
supports arbitrary room-states, state-based descriptions, embedded funcparser
tags, details and random messages. While this feature is made to be as
backwards-compatible as possible, so many people depend on this contrib class
that we are updating the major Evennia version to indicate the big changes.
- New Contrib: `Container` typeclass with new commands for storing and retrieving - New Contrib: `Container` typeclass with new commands for storing and retrieving
things inside them (InspectorCaracal) things inside them (InspectorCaracal)
- Updated Contrib: `ExtendedRoom` now supports arbitrary room-states,
state-based descriptions, embedded funcparser tags, details and random messages.
- Feature: Add `TagCategoryProperty` for setting categories with multiple tags - Feature: Add `TagCategoryProperty` for setting categories with multiple tags
as properties directly on objects. Complements `TagProperty`. as properties directly on objects. Complements `TagProperty`.
- Feature: Attribute-support for saving/loading `deques` with `maxlen=` set. - Feature: Attribute-support for saving/loading `deques` with `maxlen=` set.
@ -17,8 +22,11 @@
keyword arg, like our docs already claimed it should (Volund) keyword arg, like our docs already claimed it should (Volund)
- Fix: `TickerHandler` store key updating was refactored, fixing an issue with - Fix: `TickerHandler` store key updating was refactored, fixing an issue with
updating intervals (InspectorCaracal) updating intervals (InspectorCaracal)
- Docs: Removed warning about Python3.11 on Windows; upstream Twistd now
supports 3.11 on Windows.
- Docs: New Beginner-Tutorial lessons for NPCs, Base-Combat Twitch-Combat and - Docs: New Beginner-Tutorial lessons for NPCs, Base-Combat Twitch-Combat and
Turnbased-combat (note that the Beginner tutorial is still WIP). Turnbased-combat (note that the Beginner tutorial is still WIP).
- Fix: A lot of other minor bug fixes.
## Evennia 1.3.0 ## Evennia 1.3.0

14
docs/source/Coding/Changelog.md
View file

@ -1,11 +1,16 @@
# Changelog # Changelog
## Main branch ## Evennia 2.0
June 10, 2023
- **Possible backwards incompatibility**: Updated contrib `ExtendedRoom` now
supports arbitrary room-states, state-based descriptions, embedded funcparser
tags, details and random messages. While this feature is made to be as
backwards-compatible as possible, so many people depend on this contrib class
that we are updating the major Evennia version to indicate the big changes.
- New Contrib: `Container` typeclass with new commands for storing and retrieving - New Contrib: `Container` typeclass with new commands for storing and retrieving
things inside them (InspectorCaracal) things inside them (InspectorCaracal)
- Updated Contrib: `ExtendedRoom` now supports arbitrary room-states,
state-based descriptions, embedded funcparser tags, details and random messages.
- Feature: Add `TagCategoryProperty` for setting categories with multiple tags - Feature: Add `TagCategoryProperty` for setting categories with multiple tags
as properties directly on objects. Complements `TagProperty`. as properties directly on objects. Complements `TagProperty`.
- Feature: Attribute-support for saving/loading `deques` with `maxlen=` set. - Feature: Attribute-support for saving/loading `deques` with `maxlen=` set.
@ -17,8 +22,11 @@
keyword arg, like our docs already claimed it should (Volund) keyword arg, like our docs already claimed it should (Volund)
- Fix: `TickerHandler` store key updating was refactored, fixing an issue with - Fix: `TickerHandler` store key updating was refactored, fixing an issue with
updating intervals (InspectorCaracal) updating intervals (InspectorCaracal)
- Docs: Removed warning about Python3.11 on Windows; upstream Twistd now
supports 3.11 on Windows.
- Docs: New Beginner-Tutorial lessons for NPCs, Base-Combat Twitch-Combat and - Docs: New Beginner-Tutorial lessons for NPCs, Base-Combat Twitch-Combat and
Turnbased-combat (note that the Beginner tutorial is still WIP). Turnbased-combat (note that the Beginner tutorial is still WIP).
- Fix: A lot of other minor bug fixes.
## Evennia 1.3.0 ## Evennia 1.3.0

18
docs/source/_templates/layout.html
View file

@ -45,9 +45,6 @@
<li class="nav-item nav-item-this"><a href="{{ link|e }}">{{ title }}</a></li> <li class="nav-item nav-item-this"><a href="{{ link|e }}">{{ title }}</a></li>
{%- block relbaritems %} {% endblock %} {%- block relbaritems %} {% endblock %}
</ul> </ul>
{%- if release == '1.0-dev' %}
<div class="develop">develop branch</div>
{%- endif %}
</div> </div>
{%- endmacro %} {%- endmacro %}
@ -170,11 +167,24 @@
{%- block extrahead %} {% endblock %} {%- block extrahead %} {% endblock %}
</head> </head>
{%- block body_tag %}<body>{% endblock %} {%- block body_tag %}<body>{% endblock %}
{%- block header %}{% endblock %} {%- block header %}
{% endblock %}
{%- block relbar1 %}{{ relbar() }}{% endblock %} {%- block relbar1 %}{{ relbar() }}{% endblock %}
{%- block content %} {%- block content %}
{% if legacy_versions %}
{% if release in legacy_versions %}
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">You are reading an old version of this documentation.</p>
</div>
{% endif %}
{% endif %}
{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %} {%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
<div class="document"> <div class="document">

6
docs/source/_templates/versioning.html
View file

@ -1,13 +1,13 @@
{% if versions %} {% if versions %}
<h3>{{ _('Versions') }}</h3> <h3>{{ _('Doc Versions') }}</h3>
<ul> <ul>
{%- for item in versions %} {% for item in versions %}
<li><a href="{{ item.url }}">{{ item.release }} ({{ item.name }} branch)</a></li> <li><a href="{{ item.url }}">{{ item.release }} ({{ item.name }} branch)</a></li>
{%- endfor %} {%- endfor %}
{% if legacy_versions %} <ul> {% if legacy_versions %} <ul>
{%- for item in legacy_versions %} {%- for item in legacy_versions %}
<li><a href="{{ item.url }}">{{ item.release }} ({{ item.name }} branch)</a></li> <li><a href="{{ item.url }}">{{ item.release }} ({{ item.name }} branch)</a></li>
{%- endfor %} {% endfor %}
{% endif %} {% endif %}
</ul> </ul>
{% endif %} {% endif %}

10
docs/source/conf.py
View file

@ -20,7 +20,7 @@ author = "The Evennia developer community"
# The full Evennia version covered by these docs, including alpha/beta/rc tags # The full Evennia version covered by these docs, including alpha/beta/rc tags
# This will be used for multi-version selection options. # This will be used for multi-version selection options.
release = "1.0" release = "2.x"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
@ -54,7 +54,7 @@ html_static_path = ["_static"]
# which branches to include in multi-versioned docs # which branches to include in multi-versioned docs
# smv_branch_whitelist = r"^develop$|^v[0-9\.]+?$" # smv_branch_whitelist = r"^develop$|^v[0-9\.]+?$"
# smv_branch_whitelist = r"^develop$|^master$|^v1.0$" # smv_branch_whitelist = r"^develop$|^master$|^v1.0$"
smv_branch_whitelist = r"^develop$|^main$" smv_branch_whitelist = r"^main$"
smv_outputdir_format = "{config.release}" smv_outputdir_format = "{config.release}"
# don't make docs for tags # don't make docs for tags
smv_tag_whitelist = r"^$" smv_tag_whitelist = r"^$"
@ -62,15 +62,15 @@ smv_tag_whitelist = r"^$"
# used to fill in versioning.html links for versions that are not actually built. # used to fill in versioning.html links for versions that are not actually built.
# These are also read from the deploy.py script. These are also the names of # These are also read from the deploy.py script. These are also the names of
# the folders built in the gh-pages evennia branch, under docs/. # the folders built in the gh-pages evennia branch, under docs/.
latest_version = "1.0" latest_version = "2.x"
legacy_versions = ["0.9.5"] legacy_versions = ["1.3.0", "0.9.5"]
def add_legacy_versions_to_html_page_context(app, pagename, templatename, context, doctree): def add_legacy_versions_to_html_page_context(app, pagename, templatename, context, doctree):
# this is read by versioning.html template (sidebar) # this is read by versioning.html template (sidebar)
LVersion = namedtuple("legacy_version", ["release", "name", "url"]) LVersion = namedtuple("legacy_version", ["release", "name", "url"])
context["legacy_versions"] = [ context["legacy_versions"] = [
LVersion(release=f"{vers}", name=f"v{vers}", url=f"../{vers}/index.html") LVersion(release=f"{vers}", name=f"v{vers}", url=f"../../{vers}/index.html")
for vers in legacy_versions for vers in legacy_versions
] ]

2
evennia/VERSION.txt
View file

@ -1 +1 @@
1.3.0 2.0

2
pyproject.toml
View file

@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "evennia" name = "evennia"
version = "1.3.0" version = "2.0.0"
maintainers = [{ name = "Griatch", email = "griatch@gmail.com" }] maintainers = [{ name = "Griatch", email = "griatch@gmail.com" }]
description = "A full-featured toolkit and server for text-based multiplayer games (MUDs, MU*, etc)." description = "A full-featured toolkit and server for text-based multiplayer games (MUDs, MU*, etc)."
requires-python = ">=3.10" requires-python = ">=3.10"