Skip to content

Commit 4aaa49e

Browse files
authored
Revert auto_id_prefix override for RST rendering
1 parent 24f8e1f commit 4aaa49e

3 files changed

Lines changed: 28 additions & 29 deletions

File tree

lib/github/commands/rest2html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,6 @@ SETTINGS = {
160160
'syntax_highlight': 'none',
161161
'math_output': 'latex',
162162
'field_name_limit': 50,
163-
'auto_id_prefix': 'id',
164163
}
165164

166165
default_highlight_language = None

test/markups/README.long.rst.html

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ <h1>Robot Framework 7.0</h1>
4646
</ul>
4747
</div>
4848
<a name="installation"></a>
49-
<h2><a href="#id1">Installation</a></h2>
49+
<h2><a href="#toc-entry-1">Installation</a></h2>
5050
<p>If you have <a href="http://pip-installer.org">pip</a> installed, just run</p>
5151
<pre>
5252
pip install --upgrade robotframework
@@ -59,7 +59,7 @@ <h2><a href="#id1">Installation</a></h2>
5959
from <a href="https://pypi.python.org/pypi/robotframework">PyPI</a> and install it manually. For more details and other installation
6060
approaches, see the <a href="../../INSTALL.rst">installation instructions</a>.</p>
6161
<a name="most-important-enhancements"></a>
62-
<h2><a href="#id2">Most important enhancements</a></h2>
62+
<h2><a href="#toc-entry-2">Most important enhancements</a></h2>
6363
<blockquote>
6464
<p>If you are interested to learn more about the new features in Robot Framework 7.0,
6565
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
@@ -71,7 +71,7 @@ <h2><a href="#id2">Most important enhancements</a></h2>
7171
used for future Robot Framework development.</p>
7272
</blockquote>
7373
<a name="listener-enhancements"></a>
74-
<h3><a href="#id3">Listener enhancements</a></h3>
74+
<h3><a href="#toc-entry-3">Listener enhancements</a></h3>
7575
<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
7676
notifications about various events during execution and it also allows modifying
7777
data and results on the fly. It is not typically directly used by normal Robot
@@ -179,7 +179,7 @@ <h4>Paths are passed to version 3 listeners as <code>pathlib.Path</code> objects
179179
paths were strings, but nowadays listener version 3 methods get them as
180180
more convenient <a href="https://docs.python.org/3/library/pathlib.html">pathlib.Path</a> objects.</p>
181181
<a name="native-var-syntax"></a>
182-
<h3><a href="#id4">Native <code>VAR</code> syntax</a></h3>
182+
<h3><a href="#toc-entry-4">Native <code>VAR</code> syntax</a></h3>
183183
<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
184184
as well as global, suite and test/task scoped variables dynamically during
185185
execution. The motivation is to have a more convenient syntax than using
@@ -245,7 +245,7 @@ <h3><a href="#id4">Native <code>VAR</code> syntax</a></h3>
245245
IF 1 &gt; 0 VAR ${x} true value ELSE VAR ${x} false value
246246
</pre>
247247
<a name="mixed-argument-support-with-library-keywords"></a>
248-
<h3><a href="#id5">Mixed argument support with library keywords</a></h3>
248+
<h3><a href="#toc-entry-5">Mixed argument support with library keywords</a></h3>
249249
<p>User keywords got support to use both embedded and normal arguments in Robot
250250
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
251251
(<a href="https://github.com/robotframework/robotframework/issues/4710">#4710</a>). The syntax works so, that if a function or method implementing a keyword
@@ -266,7 +266,7 @@ <h3><a href="#id5">Mixed argument support with library keywords</a></h3>
266266
Number of dogs should be 3
267267
</pre>
268268
<a name="json-result-format"></a>
269-
<h3><a href="#id6">JSON result format</a></h3>
269+
<h3><a href="#toc-entry-6">JSON result format</a></h3>
270270
<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>
271271
and Robot Framework 7.0 extends the JSON serialization support to execution results
272272
(<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
@@ -293,7 +293,7 @@ <h3><a href="#id6">JSON result format</a></h3>
293293
<p>The plan is to enhance the support for JSON output files in the future so that
294294
they could be created already during execution. For more details see issue <a href="https://github.com/robotframework/robotframework/issues/3423">#3423</a>.</p>
295295
<a name="argument-conversion-enhancements"></a>
296-
<h3><a href="#id7">Argument conversion enhancements</a></h3>
296+
<h3><a href="#toc-entry-7">Argument conversion enhancements</a></h3>
297297
<p>Automatic argument conversion is a very powerful feature that library developers
298298
can use to avoid converting arguments manually and to get more useful Libdoc
299299
documentation. There are two important new enhancements to it.</p>
@@ -340,7 +340,7 @@ <h4>Support "stringified" types like <code>'list[int]'</code> and <code>'int |
340340
<p>These stringified types are also compatible with the Remote library API and other
341341
scenarios where using actual types is not possible.</p>
342342
<a name="tags-set-globally-can-be-removed-using-tag-syntax"></a>
343-
<h3><a href="#id8">Tags set globally can be removed using <code>-tag</code> syntax</a></h3>
343+
<h3><a href="#toc-entry-8">Tags set globally can be removed using <code>-tag</code> syntax</a></h3>
344344
<p>Individual tests and keywords can nowadays remove tags that have been set in
345345
the Settings section with <code>Test Tags</code> or <code>Keyword Tags</code> settings by using
346346
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,
@@ -364,15 +364,15 @@ <h3><a href="#id8">Tags set globally can be removed using <code>-tag</code> synt
364364
deprecated (<a href="https://github.com/robotframework/robotframework/issues/4365">#4365</a>) and using the new <code>-tag</code> syntax is recommended. With
365365
keywords there was no similar functionality earlier.</p>
366366
<a name="dynamic-and-hybrid-library-apis-support-asynchronous-execution"></a>
367-
<h3><a href="#id9">Dynamic and hybrid library APIs support asynchronous execution</a></h3>
367+
<h3><a href="#toc-entry-9">Dynamic and hybrid library APIs support asynchronous execution</a></h3>
368368
<p>Dynamic and hybrid libraries nowadays support asynchronous execution.
369369
In practice the special methods like <code>get_keyword_names</code> and <code>run_keyword</code>
370370
can be implemented as async methods (<a href="https://github.com/robotframework/robotframework/issues/4803">#4803</a>).</p>
371371
<p>Async support was added to the normal static library API in Robot Framework
372372
6.1 (<a href="https://github.com/robotframework/robotframework/issues/4089">#4089</a>). A bug related to handling asynchronous keywords if execution
373373
is stopped gracefully has also been fixed (<a href="https://github.com/robotframework/robotframework/issues/4808">#4808</a>).</p>
374374
<a name="timestamps-in-result-model-and-output-xml-use-standard-format"></a>
375-
<h3><a href="#id10">Timestamps in result model and output.xml use standard format</a></h3>
375+
<h3><a href="#toc-entry-10">Timestamps in result model and output.xml use standard format</a></h3>
376376
<p>Timestamps used in the result model and stored to the output.xml file used custom
377377
format like <code>20231107 19:57:01.123</code> earlier. Non-standard formats are seldom
378378
a good idea, and in this case parsing the custom format turned out to be slow
@@ -404,18 +404,18 @@ <h3><a href="#id10">Timestamps in result model and output.xml use standard forma
404404
that process timestamps. This is discussed more in <a href="#changes-to-output-xml">Changes to output.xml</a>
405405
section below along with other output.xml changes.</p>
406406
<a name="dark-mode-support-to-report-and-log"></a>
407-
<h3><a href="#id11">Dark mode support to report and log</a></h3>
407+
<h3><a href="#toc-entry-11">Dark mode support to report and log</a></h3>
408408
<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
409409
on browser and operating system preferences, but there is also a toggle to
410410
switch between the modes.</p>
411411
<a name="backwards-incompatible-changes"></a>
412-
<h2><a href="#id12">Backwards incompatible changes</a></h2>
412+
<h2><a href="#toc-entry-12">Backwards incompatible changes</a></h2>
413413
<a name="python-3-6-and-3-7-are-no-longer-supported"></a>
414-
<h3><a href="#id13">Python 3.6 and 3.7 are no longer supported</a></h3>
414+
<h3><a href="#toc-entry-13">Python 3.6 and 3.7 are no longer supported</a></h3>
415415
<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
416416
that supports Python 3.6 and 3.7 is Robot Framework 6.1.1.</p>
417417
<a name="changes-to-output-xml"></a>
418-
<h3><a href="#id14">Changes to output.xml</a></h3>
418+
<h3><a href="#toc-entry-14">Changes to output.xml</a></h3>
419419
<p>The output.xml file has changed in different ways making Robot Framework 7.0
420420
incompatible with external tools processing output.xml files until these tools
421421
are updated. We try to avoid this kind of breaking changes, but in this case
@@ -485,7 +485,7 @@ <h4>Schema updates</h4>
485485
<p>The output.xml schema has been updated and can be found via
486486
<a href="https://github.com/robotframework/robotframework/tree/master/doc/schema/">https://github.com/robotframework/robotframework/tree/master/doc/schema/</a>.</p>
487487
<a name="changes-to-result-model"></a>
488-
<h3><a href="#id15">Changes to result model</a></h3>
488+
<h3><a href="#toc-entry-15">Changes to result model</a></h3>
489489
<p>There have been some changes to the result model that unfortunately affect
490490
external tools using it. The main motivation for these changes has been
491491
cleaning up the model before creating a JSON representation for it (<a href="https://github.com/robotframework/robotframework/issues/4847">#4847</a>).</p>
@@ -533,7 +533,7 @@ <h4>Deprecated attributes have been removed</h4>
533533
<p>Additionally, <code>TestSuite.keywords</code> and <code>TestCase.keywords</code> have been removed
534534
from the execution model.</p>
535535
<a name="changes-to-parsing-model"></a>
536-
<h3><a href="#id16">Changes to parsing model</a></h3>
536+
<h3><a href="#toc-entry-16">Changes to parsing model</a></h3>
537537
<p>There have been some changes also to the parsing model:</p>
538538
<ul>
539539
<li>
@@ -564,7 +564,7 @@ <h3><a href="#id16">Changes to parsing model</a></h3>
564564
</li>
565565
</ul>
566566
<a name="changes-to-libdoc-spec-files"></a>
567-
<h3><a href="#id17">Changes to Libdoc spec files</a></h3>
567+
<h3><a href="#toc-entry-17">Changes to Libdoc spec files</a></h3>
568568
<p>The following deprecated constructs have been removed from Libdoc spec files (<a href="https://github.com/robotframework/robotframework/issues/4667">#4667</a>):</p>
569569
<ul>
570570
<li>
@@ -580,7 +580,7 @@ <h3><a href="#id17">Changes to Libdoc spec files</a></h3>
580580
<p>Libdoc schema files have been updated and can be found via
581581
<a href="https://github.com/robotframework/robotframework/tree/master/doc/schema/">https://github.com/robotframework/robotframework/tree/master/doc/schema/</a>.</p>
582582
<a name="changes-to-selecting-tests-with-suite-test-and-include"></a>
583-
<h3><a href="#id18">Changes to selecting tests with <code>--suite</code>, <code>--test</code> and <code>--include</code></a></h3>
583+
<h3><a href="#toc-entry-18">Changes to selecting tests with <code>--suite</code>, <code>--test</code> and <code>--include</code></a></h3>
584584
<p>There are two changes related to selecting tests:</p>
585585
<ul>
586586
<li>When using <code>--test</code> and <code>--include</code> together, tests matching either of them
@@ -590,7 +590,7 @@ <h3><a href="#id18">Changes to selecting tests with <code>--suite</code>, <code>
590590
the prefix matched the closest parent or parents.</li>
591591
</ul>
592592
<a name="other-backwards-incompatible-changes"></a>
593-
<h3><a href="#id19">Other backwards incompatible changes</a></h3>
593+
<h3><a href="#toc-entry-19">Other backwards incompatible changes</a></h3>
594594
<ul>
595595
<li>The default value of the <code>stdin</code> argument used with <code>Process</code> library keyword
596596
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
@@ -622,9 +622,9 @@ <h3><a href="#id19">Other backwards incompatible changes</a></h3>
622622
<code>timestr_to_secs</code> utility function (<a href="https://github.com/robotframework/robotframework/issues/4861">#4861</a>).</li>
623623
</ul>
624624
<a name="deprecations"></a>
625-
<h2><a href="#id20">Deprecations</a></h2>
625+
<h2><a href="#toc-entry-20">Deprecations</a></h2>
626626
<a name="return-setting"></a>
627-
<h3><a href="#id21"><code>[Return]</code> setting</a></h3>
627+
<h3><a href="#toc-entry-21"><code>[Return]</code> setting</a></h3>
628628
<p>The <code>[Return]</code> setting for specifying the return value from user keywords has
629629
been "loudly" deprecated (<a href="https://github.com/robotframework/robotframework/issues/4876">#4876</a>). It has been "silently" deprecated since
630630
Robot Framework 5.0 when the much more versatile <code>RETURN</code> setting was introduced
@@ -636,12 +636,12 @@ <h3><a href="#id21"><code>[Return]</code> setting</a></h3>
636636
not support <code>RETURN</code>, you can use the <code>Return From Keyword</code> keyword instead.
637637
That keyword will eventually be deprecated and removed as well, though.</p>
638638
<a name="singular-section-headers"></a>
639-
<h3><a href="#id22">Singular section headers</a></h3>
639+
<h3><a href="#toc-entry-22">Singular section headers</a></h3>
640640
<p>Using singular section headers like <code>*** Test Case ***</code> or <code>*** Setting ***</code>
641641
nowadays causes a deprecation warning (<a href="https://github.com/robotframework/robotframework/issues/4432">#4432</a>). They were silently deprecated
642642
in Robot Framework 6.0 for reasons explained in issue <a href="https://github.com/robotframework/robotframework/issues/4431">#4431</a>.</p>
643643
<a name="deprecated-attributes-in-parsing-running-and-result-models"></a>
644-
<h3><a href="#id23">Deprecated attributes in parsing, running and result models</a></h3>
644+
<h3><a href="#toc-entry-23">Deprecated attributes in parsing, running and result models</a></h3>
645645
<ul>
646646
<li>In the parsing model, <code>For.variables</code>, <code>ForHeader.variables</code>, <code>Try.variable</code> and
647647
<code>ExceptHeader.variable</code> attributes have been deprecated in favor of the new <code>assign</code>
@@ -663,7 +663,7 @@ <h3><a href="#id23">Deprecated attributes in parsing, running and result models<
663663
<code>name</code>, <code>owner</code> and <code>source_name</code> instead.</li>
664664
</ul>
665665
<a name="other-deprecated-features"></a>
666-
<h3><a href="#id24">Other deprecated features</a></h3>
666+
<h3><a href="#toc-entry-24">Other deprecated features</a></h3>
667667
<ul>
668668
<li>Using embedded arguments with a variable that has a value not matching custom
669669
embedded argument patterns nowadays causes a deprecation warning (<a href="https://github.com/robotframework/robotframework/issues/4524">#4524</a>).
@@ -687,7 +687,7 @@ <h3><a href="#id24">Other deprecated features</a></h3>
687687
has been deprecated (<a href="https://github.com/robotframework/robotframework/issues/4862">#4862</a>).</li>
688688
</ul>
689689
<a name="acknowledgements"></a>
690-
<h2><a href="#id25">Acknowledgements</a></h2>
690+
<h2><a href="#toc-entry-25">Acknowledgements</a></h2>
691691
<p>Robot Framework development is sponsored by the <a href="http://robotframework.org/foundation">Robot Framework Foundation</a>
692692
and its over 60 member organizations. If your organization is using Robot Framework
693693
and benefiting from it, consider joining the foundation to support its
@@ -731,7 +731,7 @@ <h2><a href="#id25">Acknowledgements</a></h2>
731731
<div>Robot Framework lead developer</div>
732732
</div>
733733
<a name="full-list-of-fixes-and-enhancements"></a>
734-
<h2><a href="#id26">Full list of fixes and enhancements</a></h2>
734+
<h2><a href="#toc-entry-26">Full list of fixes and enhancements</a></h2>
735735
<table>
736736

737737

test/markups/README.rst.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ <h2>Subtitle</h2>
1010
</div>
1111
<a name="header-2"></a>
1212
<a name="label-for-header-2"></a>
13-
<h2><a href="#id1">Header 2</a></h2>
13+
<h2><a href="#toc-entry-1">Header 2</a></h2>
1414
<ol>
1515
<li>Blah blah <code>code</code> blah</li>
1616
<li>More <code>code</code>, hooray</li>
@@ -109,7 +109,7 @@ <h2><a href="#id1">Header 2</a></h2>
109109
</a>
110110
<img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/621/badge.svg">
111111
<a name="field-list"></a>
112-
<h2><a href="#id2">Field list</a></h2>
112+
<h2><a href="#toc-entry-2">Field list</a></h2>
113113
<table frame="void" rules="none">
114114

115115

0 commit comments

Comments
 (0)