Skip to content

Commit 80bea10

Browse files
committed
Docs: reduce visibility of Config File V1
People is still arriving at Config File V1 and we want to avoid that as much as possible. However, we can't yet remove this documentation page since it's still working and there are people already using it. We should find a way to migrate these projects off from Config File V1 and finally remove this documentation page. However, that requires a much bigger amount of work.
1 parent 3d4d3cb commit 80bea10

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

.readthedocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ search:
1919
ranking:
2020
# Deprecated content
2121
api/v1.html: -1
22-
config-file/v1.html: -1
22+
config-file/v1.html: -5
2323

2424
# Useful content, but not something we want most users finding
2525
changelog.html: -6

docs/user/config-file/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,3 @@ The main advantages of using a configuration file over the web interface are:
2525
:maxdepth: 3
2626

2727
Version 2 <v2>
28-
Version 1 <v1>

docs/user/config-file/v1.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:orphan:
2+
13
Configuration File V1 (Deprecated)
24
==================================
35

@@ -6,7 +8,7 @@ Read the Docs has support for configuring builds with a YAML file.
68

79
.. warning::
810

9-
Version 1 shouldn't be used.
11+
Version 1 is deprecated and shouldn't be used.
1012
The version 2 of the configuration file is now available.
1113
See the :ref:`new features <config-file/v2:New settings>`
1214
and :ref:`how to migrate from v1 <config-file/v2:Migrating from v1>`.

0 commit comments

Comments
 (0)