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.

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

Docs: testing for file tree diff #11751

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ formats:

sphinx:
configuration: docs/conf.py
fail_on_warning: true
fail_on_warning: false

python:
install:
Expand Down
4 changes: 4 additions & 0 deletions docs/user/added.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Title
=====

This file was added.
37 changes: 0 additions & 37 deletions docs/user/guides/best-practice/index.rst

This file was deleted.

92 changes: 0 additions & 92 deletions docs/user/guides/best-practice/links.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/user/guides/deprecating-content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ and you don't necessary want to make the content inaccessible.
Here you'll find some tips on how to use Read the Docs to deprecate your content
progressively and in non harmful ways.

.. seealso::

:doc:`/guides/best-practice/links`
More information about handling URL structures, renaming and removing content.

Deprecating versions
--------------------
Expand Down
1 change: 0 additions & 1 deletion docs/user/guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,4 @@ and how to write successful documentation.
Content, themes and SEO </guides/content/index>
Security and access </guides/access/index>
Account management </guides/management/index>
Best practice </guides/best-practice/index>
Troubleshooting problems </guides/troubleshooting/index>
4 changes: 0 additions & 4 deletions docs/user/guides/redirects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ which means that the reader is automatically redirected to a *new URL*.

.. seealso::

:doc:`/guides/best-practice/links`
The need for a redirect often comes from external links to your documentation.
Read more about handling links in this explanation of best practices.

:doc:`/user-defined-redirects`
If you want to know more about our implementation of redirects,
you can look up more examples in our reference before continuing with the how-to.
Expand Down
4 changes: 0 additions & 4 deletions docs/user/guides/technical-docs-seo-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,6 @@ Read the Docs supports a few different kinds of :doc:`user defined redirects </u
that should cover all the different cases such as redirecting a certain page for all project versions,
or redirecting one version to another.

.. seealso:

:doc:`/guides/best-practice/links`
Following best practices to avoid broken links is great for search engine ranking.

Canonical URLs ✅️
~~~~~~~~~~~~~~~~~~
Expand Down
5 changes: 3 additions & 2 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Read the Docs: documentation simplified
:hidden:
:caption: Getting started

/added
/tutorial/index
/intro/doctools
/intro/mkdocs
Expand Down Expand Up @@ -77,7 +78,6 @@ Read the Docs: documentation simplified
/security-log
/badges
/explanation/documentation-structure
/guides/best-practice/links
/security-implications

.. toctree::
Expand All @@ -103,7 +103,6 @@ Read the Docs: documentation simplified
Content, themes and SEO </guides/content/index>
Security and access </guides/access/index>
Account management </guides/management/index>
Best practice </guides/best-practice/index>
Troubleshooting problems </guides/troubleshooting/index>

.. toctree::
Expand All @@ -126,6 +125,8 @@ Read the Docs: documentation simplified

<a style="display: none;" rel="me" href="https://fosstodon.org/@readthedocs">Mastodon</a>

I'm changing this file.

Read the Docs simplifies managing software documentation
by building and hosting your docs automatically,
using the Git workflow you already use for code.
Expand Down
3 changes: 0 additions & 3 deletions docs/user/user-defined-redirects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ the bad user experience of a 404 page is usually best to avoid.

:doc:`/guides/redirects`
This guide shows you how to add redirects with practical examples.
:doc:`/guides/best-practice/links`
Information and tips about creating and handling external references.
:doc:`/guides/deprecating-content`
A guide to deprecating features and other topics in a documentation.

Expand All @@ -29,7 +27,6 @@ Built-in redirects

This section explains the redirects that are automatically active for all projects and how they are useful.
Built-in redirects are especially useful for creating and sharing incoming links,
which is discussed in depth in :doc:`/guides/best-practice/links`.

.. _page_redirects:

Expand Down