Skip to content

Commit 4dd8cf6

Browse files
authored
Fix docs warnings (#585)
Mostly around duplicate target names, fixed by using the anonymous link syntax on RST (two underscores).
1 parent 26f9a7b commit 4dd8cf6

File tree

9 files changed

+97
-98
lines changed

9 files changed

+97
-98
lines changed

docs/aggregates.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ The following can be imported from ``django_mysql.models``.
2121

2222
Docs:
2323
`MySQL
24-
<https://dev.mysql.com/doc/refman/en/group-by-functions.html#function_bit-and>`_ /
25-
`MariaDB <https://mariadb.com/kb/en/mariadb/bit_and/>`_.
24+
<https://dev.mysql.com/doc/refman/en/group-by-functions.html#function_bit-and>`__ /
25+
`MariaDB <https://mariadb.com/kb/en/mariadb/bit_and/>`__.
2626

2727
Example usage:
2828

@@ -41,8 +41,8 @@ The following can be imported from ``django_mysql.models``.
4141

4242
Docs:
4343
`MySQL
44-
<https://dev.mysql.com/doc/refman/en/group-by-functions.html#function_bit-or>`_ /
45-
`MariaDB <https://mariadb.com/kb/en/mariadb/bit_or/>`_.
44+
<https://dev.mysql.com/doc/refman/en/group-by-functions.html#function_bit-or>`__ /
45+
`MariaDB <https://mariadb.com/kb/en/mariadb/bit_or/>`__.
4646

4747
Example usage:
4848

@@ -61,8 +61,8 @@ The following can be imported from ``django_mysql.models``.
6161

6262
Docs:
6363
`MySQL
64-
<https://dev.mysql.com/doc/refman/en/group-by-functions.html#function_bit-xor>`_ /
65-
`MariaDB <https://mariadb.com/kb/en/mariadb/bit_xor/>`_.
64+
<https://dev.mysql.com/doc/refman/en/group-by-functions.html#function_bit-xor>`__ /
65+
`MariaDB <https://mariadb.com/kb/en/mariadb/bit_xor/>`__.
6666

6767
Example usage:
6868

@@ -80,8 +80,8 @@ The following can be imported from ``django_mysql.models``.
8080
Useful mostly for bringing back lists of ids in a single query.
8181

8282
Docs:
83-
`MySQL <https://dev.mysql.com/doc/refman/en/group-by-functions.html#function_group-concat>`_ /
84-
`MariaDB <https://mariadb.com/kb/en/mariadb/group_concat/>`_.
83+
`MySQL <https://dev.mysql.com/doc/refman/en/group-by-functions.html#function_group-concat>`__ /
84+
`MariaDB <https://mariadb.com/kb/en/mariadb/group_concat/>`__.
8585

8686
Example usage:
8787

@@ -101,8 +101,8 @@ The following can be imported from ``django_mysql.models``.
101101
increase it if you're using this for any sizeable groups.
102102

103103
``group_concat_max_len`` docs:
104-
`MySQL <https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_group_concat_max_len>`_ /
105-
`MariaDB <https://mariadb.com/kb/en/server-system-variables/#group_concat_max_len>`_.
104+
`MySQL <https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_group_concat_max_len>`__ /
105+
`MariaDB <https://mariadb.com/kb/en/server-system-variables/#group_concat_max_len>`__.
106106

107107
Optional arguments:
108108

docs/cache.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Multiple Databases
108108
If you use this with multiple databases, you'll also need to set up routing
109109
instructions for the cache table. This can be done with the same method
110110
that is described for ``DatabaseCache`` in the `Django manual
111-
<https://docs.djangoproject.com/en/1.8/topics/cache/#database-caching>`_, apart
111+
<https://docs.djangoproject.com/en/1.8/topics/cache/#database-caching>`__, apart
112112
from the application name is ``django_mysql``.
113113

114114
.. note::
@@ -204,7 +204,7 @@ ways:
204204
``cull()`` on all of your ``MySQLCache`` instances, or you can give it names
205205
to just cull those. For example, this:
206206

207-
.. code-block:: python
207+
.. code-block:: console
208208
209209
$ python manage.py cull_mysql_caches default other_cache
210210

docs/checks.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ truncation upon insertion, by escalating warnings into errors. It is strongly
2929
recommended you activate it.
3030

3131
Docs:
32-
`MySQL <https://dev.mysql.com/doc/refman/en/sql-mode.html#sql-mode-strict>`_ /
33-
`MariaDB <https://mariadb.com/kb/en/mariadb/sql_mode/#strict-mode>`_.
32+
`MySQL <https://dev.mysql.com/doc/refman/en/sql-mode.html#sql-mode-strict>`__ /
33+
`MariaDB <https://mariadb.com/kb/en/mariadb/sql_mode/#strict-mode>`__.
3434

3535
It is configured as part of ``sql_mode``, a system variable contains a list of
3636
comma-separated modes to activate. Please check the value of your install and
@@ -73,8 +73,8 @@ Normally this just affects per-table settings for compression. It's recommended
7373
you activate this, but it's not very likely to affect you if you don't.
7474

7575
Docs:
76-
`MySQL <https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_strict_mode>`_ /
77-
`MariaDB <https://mariadb.com/kb/en/mariadb/xtradbinnodb-strict-mode/>`_.
76+
`MySQL <https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_strict_mode>`__ /
77+
`MariaDB <https://mariadb.com/kb/en/mariadb/xtradbinnodb-strict-mode/>`__.
7878

7979
As above, the easiest way to set this is to add ``SET`` to ``init_command`` in
8080
your ``DATABASES`` setting:
@@ -115,8 +115,8 @@ you'll never see any of these 'supplementary' Unicode characters (note: it's
115115
very easy for users to type emoji on phone keyboards these days!).
116116

117117
Docs:
118-
`MySQL <https://dev.mysql.com/doc/refman/en/charset-unicode-utf8mb4.html>`_ /
119-
`MariaDB <https://mariadb.com/kb/en/mariadb/unicode/>`_.
118+
`MySQL <https://dev.mysql.com/doc/refman/en/charset-unicode-utf8mb4.html>`__ /
119+
`MariaDB <https://mariadb.com/kb/en/mariadb/unicode/>`__.
120120

121121
Also see this classic blogpost:
122122
`How to support full Unicode in MySQL databases <https://mathiasbynens.be/notes/mysql-utf8mb4>`_.
@@ -149,4 +149,4 @@ Note this does not transform the database, tables, and columns that already
149149
exist. Follow the examples in the 'How to' blog post link above to fix your
150150
database, tables, and character set. It's planned to add a command to
151151
Django-MySQL to help you do this, see
152-
`Issue 216 <https://github.com/adamchainz/django-mysql/issues/216>`_.
152+
`Issue 216 <https://github.com/adamchainz/django-mysql/issues/216>`__.

0 commit comments

Comments
 (0)