Skip to content

Post 2.6.0: Fix changelog and docs issues #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sharktide merged 4 commits into from
Sep 28, 2025
Merged

Post 2.6.0: Fix changelog and docs issues #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b790af
Fix #129 - Update docs version
sharktide Sep 28, 2025
0310787
Add 2.5.1 to changelog
sharktide Sep 28, 2025
1faa437
Add appropriate changelog entries
sharktide Sep 28, 2025
9ce4c84
Fix OPTIMIZE docs rendering
sharktide Sep 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 25 additions & 5 deletions docs/source/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,38 @@ Changelog

*Note: This changelog skips version 0.1.1*

Major release 2
reStructuredPython 2
---------------

.. raw:: html

<details>
<summary>2.5.0</summary>
<summary>2.6.0</summary>
<ul>
<li>Introduced &lt;OPTIMIZE&gt; markers, which allow restructuredpython code to be executed faster than cpython would normally when restructuredpython is installed.
<li>Add optimizations to functions</li>
<li>Fix &lt;OPTIMIZE&gt; not preserving indent</li>
<li>Add multithreading to loops</li>
</ul>
</details>

<details>
<summary>2.5.0 - 2.5.1</summary>
<details>
<summary>2.5.0</summary>
<ul>
<li>Introduced &lt;OPTIMIZE&gt; markers, which allow restructuredpython code to be executed faster than cpython would normally when restructuredpython is installed.
</ul>
</details>
<details>
<summary>2.5.1</summary>
<ul>
<li>Add syntax guide back for SEO and clarity by @sharktide in #95</li>
<li>Add -v and --version flags by @sharktide in #84</li>
<li>Explicitly state <OPTIMIZE ...> on functions does nothing by @sharktide in #109</li>
</ul>
</details>
</details>

<details>
<summary>2.4.0</summary>
<ul>
Expand Down Expand Up @@ -70,7 +90,7 @@ Major release 2
</ul>
</details>

Major release 1
reStructuredPython 1
---------------

.. raw:: html
Expand All @@ -91,7 +111,7 @@ Major release 1
</ul>
</details>

Major release 0
reStructuredPython 0
---------------

.. raw:: html
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
copyright = '2025, Rihaan Meher'
author = 'Rihaan Meher'

release = '2.5.0'
release = '2.6.0'
html_favicon = "_static/icon.png"

# -- General configuration ---------------------------------------------------
Expand Down
17 changes: 9 additions & 8 deletions docs/source/reference/Features/OPTIMIZE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ Use ``<OPTIMIZE ...>`` before a ``for`` or ``while`` loop to apply runtime enhan

.. code-block:: python

<OPTIMIZE gct=True, parallel=True, profile=True, cache=True>
for i in range(10_000_000) {
temp = str(i) * 10
}
<OPTIMIZE gct=True, parallel=True, profile=True, cache=True>
for i in range(10_000_000) {
temp = str(i) * 10
}

.. versionadded::
Added the cache option in 2.6.0

.. versionchanged::
Changed the parallel functionality in 2.6.0
.. versionadded:: 2.6.0
The cache option

.. versionchanged:: 2.6.0
The parallel functionality from multiprocessing to multithreading

Arguments for <OPTIMIZE ...> on loops include:

Expand Down