Skip to content
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

Add "not latest" warning to all specs and remove latest.html #1239

Merged
merged 2 commits into from
Jan 28, 2022
Merged

Add "not latest" warning to all specs and remove latest.html #1239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f78d2a6
Add "not latest" warning to all specs and remove latest.html
turt2live Jan 26, 2022
d7d8c4b
Stop trying to link to obsolete file
Jan 28, 2022
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
8 changes: 4 additions & 4 deletions scripts/add-matrix-org-stylings.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
<div class="admonition warning" style="font-size: x-large;">
<p class="first admonition-title">Warning</p>
<p class="last">You are viewing an outdated version of this
specification. To view the current specification, please
<a class="reference external" href="latest.html">click here</a>.</p>
specification. To view the current specification, please
<a class="reference external" href="https://spec.matrix.org/latest">click here</a>.</p>
</div>
EOT

Expand All @@ -50,11 +50,11 @@

my $proposalscssinjection = <<EOT;
<style>
table.colwidths-auto tr td:nth-child(3),
table.colwidths-auto tr td:nth-child(3),
table.colwidths-auto tr td:nth-child(2) {
width: initial;
}
table.colwidths-auto tr td:nth-child(3),
table.colwidths-auto tr td:nth-child(3),
table.colwidths-auto tr td:nth-child(4) {
white-space: nowrap;
}
Expand Down
3 changes: 1 addition & 2 deletions scripts/update_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ cd "$(dirname "$(dirname "${SELF}")")"

# Set up foundations for RapiDoc API playground
rm -fr unstyled_docs/api/client-server
mkdir -p unstyled_docs/api/client-server/json
ln -s ../../../spec/client_server/latest.json unstyled_docs/api/client-server/json/api-docs.json
mkdir -p unstyled_docs/api/client-server

# copy the unstyled docs and add the styling
rm -rf content/docs
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/appendices.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1024,6 +1024,7 @@
<p><a class="anchor" id="appendices"></a></p>
<div class="section" id="appendices">
<h1><a class="toc-backref" href="#id1">1&nbsp;&nbsp;&nbsp;Appendices</a></h1>
%outdatedspecwarning%
<div class="contents topic" id="table-of-contents">
<p class="topic-title">Table of Contents</p>
<ul class="auto-toc simple">
Expand Down
1 change: 0 additions & 1 deletion unstyled_docs/spec/application_service/latest.html
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions unstyled_docs/spec/application_service/r0.1.1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>Application Service API</title>
%outdatedspecwarning%
<style type="text/css">

/*
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/application_service/r0.1.2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>Application Service API</title>
%outdatedspecwarning%
<style type="text/css">

/*
Expand Down
1 change: 0 additions & 1 deletion unstyled_docs/spec/client_server/latest.html
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion unstyled_docs/spec/client_server/latest.json
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions unstyled_docs/spec/client_server/r0.5.0.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1197,6 +1197,7 @@
<body>
<div class="document" id="client-server-api">
<h1 class="title">Client-Server API</h1>
%outdatedspecwarning%

<!-- Copyright 2016 OpenMarket Ltd -->
<!-- -->
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/client_server/r0.6.0.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1197,6 +1197,7 @@
<body>
<div class="document" id="client-server-api">
<h1 class="title">Client-Server API</h1>
%outdatedspecwarning%

<!-- Copyright 2016 OpenMarket Ltd -->
<!-- -->
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/client_server/r0.6.1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1284,6 +1284,7 @@
<body>
<div class="document" id="client-server-api">
<h1 class="title">Client-Server API</h1>
%outdatedspecwarning%

<!-- Copyright 2016 OpenMarket Ltd -->
<!-- -->
Expand Down
1 change: 0 additions & 1 deletion unstyled_docs/spec/identity_service/latest.html
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions unstyled_docs/spec/identity_service/r0.2.1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>Identity Service API</title>
%outdatedspecwarning%
<style type="text/css">

/*
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/identity_service/r0.3.0.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>Identity Service API</title>
%outdatedspecwarning%
<style type="text/css">

/*
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1004,6 +1004,7 @@
<body>
<div class="document" id="matrix-specification">
<h1 class="title">Matrix Specification</h1>
%outdatedspecwarning%

<!-- Copyright 2016 OpenMarket Ltd -->
<!-- -->
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/legacy/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -848,6 +848,7 @@
<p><a class="anchor" id="matrix-specification"></a></p>
<div class="section" id="matrix-specification">
<h1><a class="toc-backref" href="#id58">1&nbsp;&nbsp;&nbsp;Matrix Specification</a></h1>
%outdatedspecwarning%
<p><a class="anchor" id="version-0-2-0"></a></p>
<div class="section" id="version-0-2-0">
<h2><a class="toc-backref" href="#id59">1.1&nbsp;&nbsp;&nbsp;Version: 0.2.0</a></h2>
Expand Down
1 change: 0 additions & 1 deletion unstyled_docs/spec/push_gateway/latest.html
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions unstyled_docs/spec/push_gateway/r0.1.0.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -841,6 +841,7 @@
<body>
<div class="document" id="push-gateway-api">
<h1 class="title">Push Gateway API</h1>
%outdatedspecwarning%

<!-- Copyright 2016 OpenMarket Ltd -->
<!-- Copyright 2018 New Vector Ltd -->
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/push_gateway/r0.1.1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,7 @@
<body>
<div class="document" id="push-gateway-api">
<h1 class="title">Push Gateway API</h1>
%outdatedspecwarning%

<!-- Copyright 2016 OpenMarket Ltd -->
<!-- Copyright 2018 New Vector Ltd -->
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/r0.0.0/appendices.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,6 +844,7 @@

<div class="document" id="appendices">
<h1 class="title">Appendices</h1>
%outdatedspecwarning%

<p><a class="anchor" id="security-threat-model"></a></p>
<div class="section" id="security-threat-model">
Expand Down
67 changes: 34 additions & 33 deletions unstyled_docs/spec/r0.0.0/howtos.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,9 +552,9 @@
* :license: BSD, see LICENSE for details.
*
*/

/* -- page layout ----------------------------------------------------------- */

body {
font-family: Arial, sans-serif;
font-size: 100%;
Expand All @@ -576,45 +576,45 @@
hr {
border: 1px solid #B1B4B6;
}

/*
div.document {
background-color: #eee;
}
*/

div.document {
background-color: #ffffff;
color: #3E4349;
padding: 0 30px 30px 30px;
font-size: 0.9em;
}

div.footer {
color: #555;
width: 100%;
padding: 13px 0;
text-align: center;
font-size: 75%;
}

div.footer a {
color: #444;
text-decoration: underline;
}

div.related {
background-color: #6BA81E;
line-height: 32px;
color: #fff;
text-shadow: 0px 1px 0 #444;
font-size: 0.9em;
}

div.related a {
color: #E2F3CC;
}

div.sphinxsidebar {
font-size: 0.75em;
line-height: 1.5em;
Expand All @@ -623,7 +623,7 @@
div.sphinxsidebarwrapper{
padding: 20px 0;
}

div.sphinxsidebar h3,
div.sphinxsidebar h4 {
font-family: Arial, sans-serif;
Expand All @@ -639,30 +639,30 @@
div.sphinxsidebar h4{
font-size: 1.1em;
}

div.sphinxsidebar h3 a {
color: #444;
}


div.sphinxsidebar p {
color: #888;
padding: 5px 20px;
}

div.sphinxsidebar p.topless {
}

div.sphinxsidebar ul {
margin: 10px 20px;
padding: 0;
color: #000;
}

div.sphinxsidebar a {
color: #444;
}

div.sphinxsidebar input {
border: 1px solid #ccc;
font-family: sans-serif;
Expand All @@ -672,19 +672,19 @@
div.sphinxsidebar input[type=text]{
margin-left: 20px;
}

/* -- body styles ----------------------------------------------------------- */

a {
color: #005B81;
text-decoration: none;
}

a:hover {
color: #E32E00;
text-decoration: underline;
}

div.document h1,
div.document h2,
div.document h3,
Expand All @@ -699,30 +699,30 @@
padding: 5px 0 5px 10px;
text-shadow: 0px 1px 0 white
}

div.document h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; }
div.document h2 { font-size: 150%; background-color: #C8D5E3; }
div.document h3 { font-size: 120%; background-color: #D8DEE3; }
div.document h4 { font-size: 110%; background-color: #D8DEE3; }
div.document h5 { font-size: 100%; background-color: #D8DEE3; }
div.document h6 { font-size: 100%; background-color: #D8DEE3; }

a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}

a.headerlink:hover {
background-color: #c60f0f;
color: white;
}

div.document p, div.document dd, div.document li {
line-height: 1.5em;
}

div.admonition p.admonition-title + p {
display: inline;
}
Expand All @@ -735,29 +735,29 @@
background-color: #eee;
border: 1px solid #ccc;
}

div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}

div.topic {
background-color: #eee;
}

div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
}

p.admonition-title {
display: inline;
}

p.admonition-title:after {
content: ":";
}

pre {
padding: 10px;
background-color: White;
Expand All @@ -769,7 +769,7 @@
-webkit-box-shadow: 1px 1px 1px #d8d8d8;
-moz-box-shadow: 1px 1px 1px #d8d8d8;
}

tt {
background-color: #ecf0f3;
color: #222;
Expand Down Expand Up @@ -852,6 +852,7 @@
be "user" not "user_id". -->
<div class="section" id="how-to-use-the-client-server-api">
<h1>How to use the client-server API</h1>
%outdatedspecwarning%
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">The git version of this document is <tt class="docutils literal">HEAD,tag=r0.0.0,678dbbe</tt></p>
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/r0.0.0/specification.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,6 +916,7 @@
<p><a class="anchor" id="matrix-specification"></a></p>
<div class="section" id="matrix-specification">
<h1><a class="toc-backref" href="#id58">1&nbsp;&nbsp;&nbsp;Matrix Specification</a></h1>
%outdatedspecwarning%
<p><a class="anchor" id="version-0-2-0"></a></p>
<div class="section" id="version-0-2-0">
<h2><a class="toc-backref" href="#id59">1.1&nbsp;&nbsp;&nbsp;Version: 0.2.0</a></h2>
Expand Down
1 change: 1 addition & 0 deletions unstyled_docs/spec/r0.0.1/appendices.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,6 +844,7 @@

<div class="document" id="appendices">
<h1 class="title">Appendices</h1>
%outdatedspecwarning%

<p><a class="anchor" id="security-threat-model"></a></p>
<div class="section" id="security-threat-model">
Expand Down
Loading