Skip to content

DOC: make canonical version stable #19319

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
merged 1 commit into from
Jan 29, 2021
Merged

DOC: make canonical version stable #19319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion doc/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
{%- if '+' in release %}
<link rel="canonical" href="https://matplotlib.org/devdocs/{{pagename}}.html" />
{%- else %}
<link rel="canonical" href="https://matplotlib.org/{{version}}/{{pagename}}.html" />
<link rel="canonical" href="https://matplotlib.org/stable/{{pagename}}.html" />
{%- endif %}
{%- endblock %}

Expand Down
9 changes: 6 additions & 3 deletions doc/devel/release_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,13 +342,16 @@ matplotlib ::
rsync -a ../matplotlib/doc/build/html/* 2.0.0
cp ../matplotlib/doc/build/latex/Matplotlib.pdf 2.0.0

which will copy the built docs over. If this is a final release, also
replace the top-level docs ::
which will copy the built docs over. If this is a final release, link the
``stable`` subdirectory to the newest version::

rsync -a 2.0.0/* ./
rm stable
ln -s 2.0.0/ stable

You will need to manually edit :file:`versions.html` to show the last
3 tagged versions. Now commit and push everything to GitHub ::
3 tagged versions. You will also need to edit :file:`sitemap.xml` to include
the newly released version. Now commit and push everything to GitHub ::

git add *
git commit -a -m 'Updating docs for v2.0.0'
Expand Down