Skip to content

feat: Use natsort to sort references #1321

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
kesara merged 5 commits into from
Jun 3, 2026
Merged

feat: Use natsort to sort references #1321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e688a3a
feat: Use natsort to sort references
kesara Apr 13, 2026
2b48d68
test: Test for RFC and sub-series aware ref sorting
kesara Apr 13, 2026
85aa1fb
chore: Run yestests (pre-changes)
kesara Apr 13, 2026
e610651
chore: Run yestests (post-changes)
kesara Apr 13, 2026
b07d5bf
Merge branch 'main' into feat/natsort
kesara Jun 3, 2026
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 pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ dependencies = [
"intervaltree>=3.1.0",
"jinja2>=3.1.2",
"lxml>=5.3.0",
"natsort>=8.4.0",
"pycountry>=22.3.5",
"pyyaml>=5.3.1",
"requests>=2.5.0",
Expand Down
190 changes: 190 additions & 0 deletions tests/input/rfc99999.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,65 @@
<section numbered="true" toc="default">
<name>Section 31</name>
<t>redacted <xref target="RFC99998"/></t>
<t>More references:
<xref target="RFC666"/>
<xref target="RFC4321"/>
<xref target="RFC1"/>
<xref target="RFC99"/>
<xref target="BCP101"/>
<xref target="BCP3"/>
<xref target="BCP10"/>
<xref target="STD101"/>
<xref target="STD30"/>
<xref target="STD2"/>
<xref target="ACME"/>
<xref target="FOOBAR"/>
<xref target="RFCed"/>
<xref target="ZULU"/>
</t>
</section>
</middle>
<back>
<references>
<name>References</name>
<references>
<name>Normative References</name>
<reference anchor="RFC666" target="https://www.rfc-editor.org/info/rfc666">
<front>
<title>General Order 24</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="October" year="2024"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="RFC" value="666"/>
<seriesInfo name="DOI" value="10.17487/RFC666"/>
</reference>
<reference anchor="RFC4321" target="https://www.rfc-editor.org/info/rfc4321">
<front>
<title>General Order 7</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="October" year="2024"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="RFC" value="4321"/>
<seriesInfo name="DOI" value="10.17487/RFC4321"/>
</reference>
<reference anchor="RFC1" target="https://www.rfc-editor.org/info/rfc1">
<front>
<title>General Order 0</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="October" year="2024"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="RFC" value="1"/>
<seriesInfo name="DOI" value="10.17487/RFC1"/>
</reference>
<reference anchor="RFC99998" target="https://www.rfc-editor.org/info/rfc99998">
<front>
<title>Prime Directive</title>
Expand All @@ -46,6 +98,144 @@
<seriesInfo name="RFC" value="99998"/>
<seriesInfo name="DOI" value="10.17487/RFC99998"/>
</reference>
<reference anchor="RFC99" target="https://www.rfc-editor.org/info/rfc99">
<front>
<title>General Order 99</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="October" year="2024"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="RFC" value="99"/>
<seriesInfo name="DOI" value="10.17487/RFC99"/>
</reference>
<referencegroup anchor="BCP101" target="https://www.rfc-editor.org/info/bcp101">
<reference anchor="RFC1111" target="https://www.rfc-editor.org/info/rfc1111">
<front>
<title>Fake Title</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="February" year="2020"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="BCP" value="101"/>
<seriesInfo name="RFC" value="1111"/>
<seriesInfo name="DOI" value="10.17487/RFC1111"/>
</reference>
</referencegroup>
<referencegroup anchor="BCP3" target="https://www.rfc-editor.org/info/bcp3">
<reference anchor="RFC1112" target="https://www.rfc-editor.org/info/rfc1112">
<front>
<title>Fake Title</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="February" year="2020"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="BCP" value="3"/>
<seriesInfo name="RFC" value="1112"/>
<seriesInfo name="DOI" value="10.17487/RFC1112"/>
</reference>
</referencegroup>
<referencegroup anchor="BCP10" target="https://www.rfc-editor.org/info/bcp10">
<reference anchor="RFC1113" target="https://www.rfc-editor.org/info/rfc1113">
<front>
<title>Fake Title</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="February" year="2020"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="BCP" value="10"/>
<seriesInfo name="RFC" value="1113"/>
<seriesInfo name="DOI" value="10.17487/RFC1113"/>
</reference>
</referencegroup>
<referencegroup anchor="STD101" target="https://www.rfc-editor.org/info/std101">
<reference anchor="RFC2222" target="https://www.rfc-editor.org/info/rfc2222">
<front>
<title>Fake Title</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="February" year="2020"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="STD" value="101"/>
<seriesInfo name="RFC" value="2222"/>
<seriesInfo name="DOI" value="10.17487/RFC2222"/>
</reference>
</referencegroup>
<referencegroup anchor="STD30" target="https://www.rfc-editor.org/info/std30">
<reference anchor="RFC2223" target="https://www.rfc-editor.org/info/rfc2223">
<front>
<title>Fake Title</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="February" year="2020"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="STD" value="30"/>
<seriesInfo name="RFC" value="2223"/>
<seriesInfo name="DOI" value="10.17487/RFC2223"/>
</reference>
</referencegroup>
<referencegroup anchor="STD2" target="https://www.rfc-editor.org/info/std2">
<reference anchor="RFC2224" target="https://www.rfc-editor.org/info/rfc2224">
<front>
<title>Fake Title</title>
<author fullname="J. Doe" initials="J." surname="Doe"/>
<date month="February" year="2020"/>
<abstract>
<t>Fake reference</t>
</abstract>
</front>
<seriesInfo name="STD" value="2"/>
<seriesInfo name="RFC" value="2224"/>
<seriesInfo name="DOI" value="10.17487/RFC2224"/>
</reference>
</referencegroup>
<reference anchor="FOOBAR" target="https://example.org">
<front>
<title>FOOBAR</title>
<author>
<organization>FOOBAR</organization>
</author>
<date year="2019"/>
</front>
</reference>
<reference anchor="ZULU" target="https://example.org">
<front>
<title>ZULU</title>
<author>
<organization>ZULU</organization>
</author>
<date year="2019"/>
</front>
</reference>
<reference anchor="RFCed" target="https://example.org">
<front>
<title>RFCed</title>
<author>
<organization>RFCed</organization>
</author>
<date year="2019"/>
</front>
</reference>
<reference anchor="ACME" target="https://example.org">
<front>
<title>ACME</title>
<author>
<organization>ACME</organization>
</author>
<date year="2019"/>
</front>
</reference>
</references>
</references>
</back>
Expand Down
1 change: 1 addition & 0 deletions tests/valid/draft-miek-test.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
intervaltree 3.2.1
Jinja2 3.1.6
lxml 6.1.1
natsort 8.4.0
platformdirs 4.10.0
pycountry 26.2.16
pypdf 6.12.2
Expand Down
1 change: 1 addition & 0 deletions tests/valid/draft-template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
intervaltree 3.2.1
Jinja2 3.1.6
lxml 6.1.1
natsort 8.4.0
platformdirs 4.10.0
pycountry 26.2.16
pypdf 6.12.2
Expand Down
Loading
Loading