Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions lib/github/commands/rest2html
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ SETTINGS = {
'syntax_highlight': 'none',
'math_output': 'latex',
'field_name_limit': 50,
'auto_id_prefix': 'id',
}

default_highlight_language = None
Expand Down
52 changes: 26 additions & 26 deletions test/markups/README.long.rst.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ <h1>Robot Framework 7.0</h1>
</ul>
</div>
<a name="installation"></a>
<h2><a href="#toc-entry-1">Installation</a></h2>
<h2><a href="#id113">Installation</a></h2>
<p>If you have <a href="http://pip-installer.org">pip</a> installed, just run</p>
<pre>
pip install --upgrade robotframework
Expand All @@ -59,7 +59,7 @@ <h2><a href="#toc-entry-1">Installation</a></h2>
from <a href="https://pypi.python.org/pypi/robotframework">PyPI</a> and install it manually. For more details and other installation
approaches, see the <a href="../../INSTALL.rst">installation instructions</a>.</p>
<a name="most-important-enhancements"></a>
<h2><a href="#toc-entry-2">Most important enhancements</a></h2>
<h2><a href="#id114">Most important enhancements</a></h2>
<blockquote>
<p>If you are interested to learn more about the new features in Robot Framework 7.0,
join the <a href="https://robocon.io">RoboCon conference</a> in February, 2024. <a href="https://github.com/pekkaklarck">Pekka Klärck</a>, Robot Framework
Expand All @@ -71,7 +71,7 @@ <h2><a href="#toc-entry-2">Most important enhancements</a></h2>
used for future Robot Framework development.</p>
</blockquote>
<a name="listener-enhancements"></a>
<h3><a href="#toc-entry-3">Listener enhancements</a></h3>
<h3><a href="#id115">Listener enhancements</a></h3>
<p>Robot Framework's <a href="http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-interface">listener interface</a> is a very powerful mechanism to get
notifications about various events during execution and it also allows modifying
data and results on the fly. It is not typically directly used by normal Robot
Expand Down Expand Up @@ -179,7 +179,7 @@ <h4>Paths are passed to version 3 listeners as <code>pathlib.Path</code> objects
paths were strings, but nowadays listener version 3 methods get them as
more convenient <a href="https://docs.python.org/3/library/pathlib.html">pathlib.Path</a> objects.</p>
<a name="native-var-syntax"></a>
<h3><a href="#toc-entry-4">Native <code>VAR</code> syntax</a></h3>
<h3><a href="#id116">Native <code>VAR</code> syntax</a></h3>
<p>The new <code>VAR</code> syntax (<a href="https://github.com/robotframework/robotframework/issues/3761">#3761</a>) makes it possible to create local variables
as well as global, suite and test/task scoped variables dynamically during
execution. The motivation is to have a more convenient syntax than using
Expand Down Expand Up @@ -245,7 +245,7 @@ <h3><a href="#toc-entry-4">Native <code>VAR</code> syntax</a></h3>
IF 1 &gt; 0 VAR ${x} true value ELSE VAR ${x} false value
</pre>
<a name="mixed-argument-support-with-library-keywords"></a>
<h3><a href="#toc-entry-5">Mixed argument support with library keywords</a></h3>
<h3><a href="#id117">Mixed argument support with library keywords</a></h3>
<p>User keywords got support to use both embedded and normal arguments in Robot
Framework 6.1 (<a href="https://github.com/robotframework/robotframework/issues/4234">#4234</a>) and now that support has been added also to library keywords
(<a href="https://github.com/robotframework/robotframework/issues/4710">#4710</a>). The syntax works so, that if a function or method implementing a keyword
Expand All @@ -266,7 +266,7 @@ <h3><a href="#toc-entry-5">Mixed argument support with library keywords</a></h3>
Number of dogs should be 3
</pre>
<a name="json-result-format"></a>
<h3><a href="#toc-entry-6">JSON result format</a></h3>
<h3><a href="#id118">JSON result format</a></h3>
<p>Robot Framework 6.1 added support to <a href="https://github.com/robotframework/robotframework/blob/master/doc/releasenotes/rf-6.1.rst#json-data-format">convert test/task data to JSON and back</a>
and Robot Framework 7.0 extends the JSON serialization support to execution results
(<a href="https://github.com/robotframework/robotframework/issues/4847">#4847</a>). One of the core use cases for data serialization was making it easy to
Expand All @@ -293,7 +293,7 @@ <h3><a href="#toc-entry-6">JSON result format</a></h3>
<p>The plan is to enhance the support for JSON output files in the future so that
they could be created already during execution. For more details see issue <a href="https://github.com/robotframework/robotframework/issues/3423">#3423</a>.</p>
<a name="argument-conversion-enhancements"></a>
<h3><a href="#toc-entry-7">Argument conversion enhancements</a></h3>
<h3><a href="#id119">Argument conversion enhancements</a></h3>
<p>Automatic argument conversion is a very powerful feature that library developers
can use to avoid converting arguments manually and to get more useful Libdoc
documentation. There are two important new enhancements to it.</p>
Expand Down Expand Up @@ -340,7 +340,7 @@ <h4>Support "stringified" types like <code>'list[int]'</code> and <code>'int |
<p>These stringified types are also compatible with the Remote library API and other
scenarios where using actual types is not possible.</p>
<a name="tags-set-globally-can-be-removed-using-tag-syntax"></a>
<h3><a href="#toc-entry-8">Tags set globally can be removed using <code>-tag</code> syntax</a></h3>
<h3><a href="#id120">Tags set globally can be removed using <code>-tag</code> syntax</a></h3>
<p>Individual tests and keywords can nowadays remove tags that have been set in
the Settings section with <code>Test Tags</code> or <code>Keyword Tags</code> settings by using
the <code>-tag</code> syntax with their own <code>[Tags]</code> setting (<a href="https://github.com/robotframework/robotframework/issues/4374">#4374</a>). For example,
Expand All @@ -364,15 +364,15 @@ <h3><a href="#toc-entry-8">Tags set globally can be removed using <code>-tag</co
deprecated (<a href="https://github.com/robotframework/robotframework/issues/4365">#4365</a>) and using the new <code>-tag</code> syntax is recommended. With
keywords there was no similar functionality earlier.</p>
<a name="dynamic-and-hybrid-library-apis-support-asynchronous-execution"></a>
<h3><a href="#toc-entry-9">Dynamic and hybrid library APIs support asynchronous execution</a></h3>
<h3><a href="#id121">Dynamic and hybrid library APIs support asynchronous execution</a></h3>
<p>Dynamic and hybrid libraries nowadays support asynchronous execution.
In practice the special methods like <code>get_keyword_names</code> and <code>run_keyword</code>
can be implemented as async methods (<a href="https://github.com/robotframework/robotframework/issues/4803">#4803</a>).</p>
<p>Async support was added to the normal static library API in Robot Framework
6.1 (<a href="https://github.com/robotframework/robotframework/issues/4089">#4089</a>). A bug related to handling asynchronous keywords if execution
is stopped gracefully has also been fixed (<a href="https://github.com/robotframework/robotframework/issues/4808">#4808</a>).</p>
<a name="timestamps-in-result-model-and-output-xml-use-standard-format"></a>
<h3><a href="#toc-entry-10">Timestamps in result model and output.xml use standard format</a></h3>
<h3><a href="#id122">Timestamps in result model and output.xml use standard format</a></h3>
<p>Timestamps used in the result model and stored to the output.xml file used custom
format like <code>20231107 19:57:01.123</code> earlier. Non-standard formats are seldom
a good idea, and in this case parsing the custom format turned out to be slow
Expand Down Expand Up @@ -404,18 +404,18 @@ <h3><a href="#toc-entry-10">Timestamps in result model and output.xml use standa
that process timestamps. This is discussed more in <a href="#changes-to-output-xml">Changes to output.xml</a>
section below along with other output.xml changes.</p>
<a name="dark-mode-support-to-report-and-log"></a>
<h3><a href="#toc-entry-11">Dark mode support to report and log</a></h3>
<h3><a href="#id123">Dark mode support to report and log</a></h3>
<p>Report and log got a new dark mode (<a href="https://github.com/robotframework/robotframework/issues/3725">#3725</a>). It is enabled automatically based
on browser and operating system preferences, but there is also a toggle to
switch between the modes.</p>
<a name="backwards-incompatible-changes"></a>
<h2><a href="#toc-entry-12">Backwards incompatible changes</a></h2>
<h2><a href="#id124">Backwards incompatible changes</a></h2>
<a name="python-3-6-and-3-7-are-no-longer-supported"></a>
<h3><a href="#toc-entry-13">Python 3.6 and 3.7 are no longer supported</a></h3>
<h3><a href="#id125">Python 3.6 and 3.7 are no longer supported</a></h3>
<p>Robot Framework 7.0 requires Python 3.8 or newer (<a href="https://github.com/robotframework/robotframework/issues/4294">#4294</a>). The last version
that supports Python 3.6 and 3.7 is Robot Framework 6.1.1.</p>
<a name="changes-to-output-xml"></a>
<h3><a href="#toc-entry-14">Changes to output.xml</a></h3>
<h3><a href="#id126">Changes to output.xml</a></h3>
<p>The output.xml file has changed in different ways making Robot Framework 7.0
incompatible with external tools processing output.xml files until these tools
are updated. We try to avoid this kind of breaking changes, but in this case
Expand Down Expand Up @@ -485,7 +485,7 @@ <h4>Schema updates</h4>
<p>The output.xml schema has been updated and can be found via
<a href="https://github.com/robotframework/robotframework/tree/master/doc/schema/">https://github.com/robotframework/robotframework/tree/master/doc/schema/</a>.</p>
<a name="changes-to-result-model"></a>
<h3><a href="#toc-entry-15">Changes to result model</a></h3>
<h3><a href="#id127">Changes to result model</a></h3>
<p>There have been some changes to the result model that unfortunately affect
external tools using it. The main motivation for these changes has been
cleaning up the model before creating a JSON representation for it (<a href="https://github.com/robotframework/robotframework/issues/4847">#4847</a>).</p>
Expand Down Expand Up @@ -533,7 +533,7 @@ <h4>Deprecated attributes have been removed</h4>
<p>Additionally, <code>TestSuite.keywords</code> and <code>TestCase.keywords</code> have been removed
from the execution model.</p>
<a name="changes-to-parsing-model"></a>
<h3><a href="#toc-entry-16">Changes to parsing model</a></h3>
<h3><a href="#id128">Changes to parsing model</a></h3>
<p>There have been some changes also to the parsing model:</p>
<ul>
<li>
Expand Down Expand Up @@ -564,7 +564,7 @@ <h3><a href="#toc-entry-16">Changes to parsing model</a></h3>
</li>
</ul>
<a name="changes-to-libdoc-spec-files"></a>
<h3><a href="#toc-entry-17">Changes to Libdoc spec files</a></h3>
<h3><a href="#id129">Changes to Libdoc spec files</a></h3>
<p>The following deprecated constructs have been removed from Libdoc spec files (<a href="https://github.com/robotframework/robotframework/issues/4667">#4667</a>):</p>
<ul>
<li>
Expand All @@ -580,7 +580,7 @@ <h3><a href="#toc-entry-17">Changes to Libdoc spec files</a></h3>
<p>Libdoc schema files have been updated and can be found via
<a href="https://github.com/robotframework/robotframework/tree/master/doc/schema/">https://github.com/robotframework/robotframework/tree/master/doc/schema/</a>.</p>
<a name="changes-to-selecting-tests-with-suite-test-and-include"></a>
<h3><a href="#toc-entry-18">Changes to selecting tests with <code>--suite</code>, <code>--test</code> and <code>--include</code></a></h3>
<h3><a href="#id130">Changes to selecting tests with <code>--suite</code>, <code>--test</code> and <code>--include</code></a></h3>
<p>There are two changes related to selecting tests:</p>
<ul>
<li>When using <code>--test</code> and <code>--include</code> together, tests matching either of them
Expand All @@ -590,7 +590,7 @@ <h3><a href="#toc-entry-18">Changes to selecting tests with <code>--suite</code>
the prefix matched the closest parent or parents.</li>
</ul>
<a name="other-backwards-incompatible-changes"></a>
<h3><a href="#toc-entry-19">Other backwards incompatible changes</a></h3>
<h3><a href="#id131">Other backwards incompatible changes</a></h3>
<ul>
<li>The default value of the <code>stdin</code> argument used with <code>Process</code> library keyword
has been changed from <code>subprocess.PIPE</code> to <code>None</code> (<a href="https://github.com/robotframework/robotframework/issues/4103">#4103</a>). This change ought
Expand Down Expand Up @@ -622,9 +622,9 @@ <h3><a href="#toc-entry-19">Other backwards incompatible changes</a></h3>
<code>timestr_to_secs</code> utility function (<a href="https://github.com/robotframework/robotframework/issues/4861">#4861</a>).</li>
</ul>
<a name="deprecations"></a>
<h2><a href="#toc-entry-20">Deprecations</a></h2>
<h2><a href="#id132">Deprecations</a></h2>
<a name="return-setting"></a>
<h3><a href="#toc-entry-21"><code>[Return]</code> setting</a></h3>
<h3><a href="#id133"><code>[Return]</code> setting</a></h3>
<p>The <code>[Return]</code> setting for specifying the return value from user keywords has
been "loudly" deprecated (<a href="https://github.com/robotframework/robotframework/issues/4876">#4876</a>). It has been "silently" deprecated since
Robot Framework 5.0 when the much more versatile <code>RETURN</code> setting was introduced
Expand All @@ -636,12 +636,12 @@ <h3><a href="#toc-entry-21"><code>[Return]</code> setting</a></h3>
not support <code>RETURN</code>, you can use the <code>Return From Keyword</code> keyword instead.
That keyword will eventually be deprecated and removed as well, though.</p>
<a name="singular-section-headers"></a>
<h3><a href="#toc-entry-22">Singular section headers</a></h3>
<h3><a href="#id134">Singular section headers</a></h3>
<p>Using singular section headers like <code>*** Test Case ***</code> or <code>*** Setting ***</code>
nowadays causes a deprecation warning (<a href="https://github.com/robotframework/robotframework/issues/4432">#4432</a>). They were silently deprecated
in Robot Framework 6.0 for reasons explained in issue <a href="https://github.com/robotframework/robotframework/issues/4431">#4431</a>.</p>
<a name="deprecated-attributes-in-parsing-running-and-result-models"></a>
<h3><a href="#toc-entry-23">Deprecated attributes in parsing, running and result models</a></h3>
<h3><a href="#id135">Deprecated attributes in parsing, running and result models</a></h3>
<ul>
<li>In the parsing model, <code>For.variables</code>, <code>ForHeader.variables</code>, <code>Try.variable</code> and
<code>ExceptHeader.variable</code> attributes have been deprecated in favor of the new <code>assign</code>
Expand All @@ -663,7 +663,7 @@ <h3><a href="#toc-entry-23">Deprecated attributes in parsing, running and result
<code>name</code>, <code>owner</code> and <code>source_name</code> instead.</li>
</ul>
<a name="other-deprecated-features"></a>
<h3><a href="#toc-entry-24">Other deprecated features</a></h3>
<h3><a href="#id136">Other deprecated features</a></h3>
<ul>
<li>Using embedded arguments with a variable that has a value not matching custom
embedded argument patterns nowadays causes a deprecation warning (<a href="https://github.com/robotframework/robotframework/issues/4524">#4524</a>).
Expand All @@ -687,7 +687,7 @@ <h3><a href="#toc-entry-24">Other deprecated features</a></h3>
has been deprecated (<a href="https://github.com/robotframework/robotframework/issues/4862">#4862</a>).</li>
</ul>
<a name="acknowledgements"></a>
<h2><a href="#toc-entry-25">Acknowledgements</a></h2>
<h2><a href="#id137">Acknowledgements</a></h2>
<p>Robot Framework development is sponsored by the <a href="http://robotframework.org/foundation">Robot Framework Foundation</a>
and its over 60 member organizations. If your organization is using Robot Framework
and benefiting from it, consider joining the foundation to support its
Expand Down Expand Up @@ -731,7 +731,7 @@ <h2><a href="#toc-entry-25">Acknowledgements</a></h2>
<div>Robot Framework lead developer</div>
</div>
<a name="full-list-of-fixes-and-enhancements"></a>
<h2><a href="#toc-entry-26">Full list of fixes and enhancements</a></h2>
<h2><a href="#id138">Full list of fixes and enhancements</a></h2>
<table>


Expand Down
4 changes: 2 additions & 2 deletions test/markups/README.rst.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ <h2>Subtitle</h2>
</div>
<a name="header-2"></a>
<a name="label-for-header-2"></a>
<h2><a href="#toc-entry-1">Header 2</a></h2>
<h2><a href="#id1">Header 2</a></h2>
<ol>
<li>Blah blah <code>code</code> blah</li>
<li>More <code>code</code>, hooray</li>
Expand Down Expand Up @@ -109,7 +109,7 @@ <h2><a href="#toc-entry-1">Header 2</a></h2>
</a>
<img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/621/badge.svg">
<a name="field-list"></a>
<h2><a href="#toc-entry-2">Field list</a></h2>
<h2><a href="#id2">Field list</a></h2>
<table frame="void" rules="none">


Expand Down
Loading