You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/upgrade/1-1-to-1-2.rst
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,17 +20,15 @@ Here are the main breaking changes between the 1.1 and 1.2 versions.
20
20
#. Update the following Python dependencies in ``docs/pyproject.toml``:
21
21
22
22
.. code-block::
23
-
24
-
sphinx-scylladb-theme = "~1.2.0"
23
+
24
+
sphinx-scylladb-theme = "~1.2.0"
25
25
sphinx-multiversion-scylla = "~0.2.11"
26
-
sphinx-scylladb-theme = "~1.2.0"
27
26
28
27
#. Remove the following dependency in ``docs/pyproject.toml``:
29
28
30
29
.. code-block::
31
30
32
-
sphinx-sitemap = "^2.1.0"
33
-
31
+
sphinx-sitemap = "^2.1.0"
34
32
35
33
#. Edit ``docs/Makefile``:
36
34
@@ -43,7 +41,7 @@ Here are the main breaking changes between the 1.1 and 1.2 versions.
43
41
With:
44
42
45
43
.. code-block::
46
-
44
+
47
45
POETRY = poetry
48
46
49
47
# Windows variables
@@ -87,7 +85,7 @@ Listing unstable versions
87
85
88
86
To list versions as unstable:
89
87
90
-
#. Define in your `conf.py` the list ``UNSTABLE_VERSIONS``:
88
+
#. Define in your ``conf.py`` the list ``UNSTABLE_VERSIONS``:
91
89
92
90
.. code-block:: python
93
91
@@ -107,7 +105,9 @@ Sitemap
107
105
.......
108
106
109
107
Sitemaps are useful for search engines to index content.
110
-
To generate a ``sitemap.xml`` for the site, add the following line in the ``conf.py`` file:
108
+
By default, the theme now automatically generates a sitemap for the site.
109
+
110
+
If your project has the multiversion extension enabled, add the following line in the ``conf.py`` file:
111
111
112
112
.. code-block:: python
113
113
@@ -116,7 +116,7 @@ To generate a ``sitemap.xml`` for the site, add the following line in the ``conf
116
116
Changes in custom landing pages
117
117
...............................
118
118
119
-
If you were using the :ref:`Custom landing page feature <new_landing_page>`, add the following lines at the top of the file ``docs/source/index.rst``:
119
+
If your project uses the :ref:`Custom landing page feature <new_landing_page>`, add the following lines at the top of the file ``docs/source/index.rst``:
0 commit comments