Skip to content

Commit 084195d

Browse files
authored
Merge pull request #14817 from nextcloud/copilot/backport-14769-and-14771-to-stable32
[stable32] Backport sphinx-lint CI (#14769) and enable all checks (#14771) to stable32
2 parents 09ed5bf + caf2f88 commit 084195d

213 files changed

Lines changed: 4039 additions & 3983 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"problemMatcher": [
3+
{
4+
"owner": "sphinx-lint",
5+
"pattern": [
6+
{
7+
"regexp": "^([^:]+\\.(?:rst|py)):(\\d+): (.+)$",
8+
"file": 1,
9+
"line": 2,
10+
"message": 3
11+
}
12+
]
13+
}
14+
]
15+
}

.github/workflows/sphinx-lint.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: 'Sphinx Lint'
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- master
8+
- stable*
9+
10+
permissions:
11+
contents: read
12+
13+
jobs:
14+
sphinx-lint:
15+
name: Lint RST files
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout repository
20+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
21+
with:
22+
persist-credentials: false
23+
24+
- name: Set up Python
25+
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
26+
with:
27+
python-version: "3.13"
28+
cache: "pip"
29+
30+
# The workflow pins sphinx-lint directly (not via requirements.txt) to keep
31+
# this job lightweight — requirements.txt pulls in the full Sphinx build
32+
# stack (Pillow, rst2pdf, reportlab, …) which is not needed for linting.
33+
# sphinx-lint is also listed in requirements.txt so local dev environments
34+
# get the same version when running `pip install -r requirements.txt`.
35+
- name: Install sphinx-lint
36+
run: pip install sphinx-lint==1.0.2
37+
38+
- name: Register sphinx-lint problem matcher
39+
run: echo "::add-matcher::.github/problem-matchers/sphinx-lint.json"
40+
41+
- name: Run sphinx-lint
42+
run: sphinx-lint admin_manual developer_manual user_manual

admin_manual/ai/app_context_agent.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -442,8 +442,8 @@ Known Limitations
442442
-----------------
443443
* Make sure to test the language model you are using in concert with this app for whether they meet the use-case's quality requirements
444444
* Most models have difficulties with languages other than English. Some models sometimes answer in a different language than the one used by the user.
445-
* Customer support is available upon request, however we can't solve false or problematic output, most performance issues, or other problems caused by the underlying model.
446-
Support is thus limited only to bugs directly caused by the implementation of the app (connectors, API, front-end, AppAPI). We still try to optimize this as far as possible, so if you encounter any false or problematic output, you can report it `in a dedicated Github issue <https://github.com/nextcloud/context_agent/issues/51>`_ to help us improve this app.
445+
* Customer support is available upon request, however we can't solve false or problematic output, most performance issues, or other problems caused by the underlying model.
446+
Support is thus limited only to bugs directly caused by the implementation of the app (connectors, API, front-end, AppAPI). We still try to optimize this as far as possible, so if you encounter any false or problematic output, you can report it `in a dedicated Github issue <https://github.com/nextcloud/context_agent/issues/51>`_ to help us improve this app.
447447
* When multiple MCP services are configured that have tools with the same name undefined behavior will occur.
448448
* Only remote MCP services are supported (streamable_http transport).
449-
* MCP services that require different access tokens for each user are not currently supported.
449+
* MCP services that require different access tokens for each user are not currently supported.

admin_manual/ai/app_summary_bot.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ After cloning this app *manually* (cloned via git to your apps directory) you wi
8888
.. code-block::
8989
9090
sudo -E -u www-data php occ app_api:app:unregister summary_bot
91-
91+
9292
9393
5. Register the Summary Bot so that your Nextcloud instance is aware of it
9494

@@ -125,7 +125,7 @@ Ethical AI Rating
125125

126126
The ethical rating of the *Summary Bot*, which utilizes a model for text processing through the Nextcloud Assistant app, is significantly influenced by the choice and implementation of the underlying model.
127127

128-
Learn more about the Nextcloud Ethical AI Rating `in our blog<https://nextcloud.com/blog/nextcloud-ethical-ai-rating/>`.
128+
Learn more about the Nextcloud Ethical AI Rating `in our blog <https://nextcloud.com/blog/nextcloud-ethical-ai-rating/>`_.
129129

130130
Known Limitations
131131
-----------------

admin_manual/ai/insight_and_debugging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,4 @@ For example
9191
{
9292
...
9393
}
94-
]
94+
]

admin_manual/apps_management.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ For example, to enable the "files" app, run:
100100
To enable the app for specific groups, use the `--groups` option:
101101

102102
::
103-
103+
104104
occ app:enable files --groups=admin
105105

106106

admin_manual/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# https://www.sphinx-doc.org/en/master/usage/configuration.html
77
#
88
## Note that additional configuration elements shared by all Nextcloud docs
9-
## are loaded from `../conf.py`.
9+
## are loaded from `../conf.py`.
1010

1111
# -- Path setup --------------------------------------------------------------
1212

@@ -119,7 +119,7 @@
119119
'Nextcloud',
120120
'The Nextcloud Server Administration Manual.',
121121
'Miscellaneous',
122-
),
122+
),
123123
]
124124

125125
# -- Options for todo extension ----------------------------------------------

admin_manual/configuration_database/bigint_identifiers.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ BigInt (64bit) identifiers
33
==========================
44

55
Nextcloud uses big integers to store identifiers and auto-increment keys in the database.
6-
Because changing columns on huge tables can take quite a while (up to hours or days)
7-
depending on the number of files in the Nextcloud instance, this migration on the filecache
6+
Because changing columns on huge tables can take quite a while (up to hours or days)
7+
depending on the number of files in the Nextcloud instance, this migration on the filecache
88
and activity table has to be triggered manually by a console command.
99

1010
The command can safely be executed. It will show a success message when there is nothing to do::

admin_manual/configuration_database/db_conversion.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Conversion consists of two steps:
1919
Establishing the target database
2020
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2121

22-
First create up the target (new) database (along with its associated username and password) by following the manual database configuration instructions for your chosen target database type:
22+
First create up the target (new) database (along with its associated username and password) by following the manual database configuration instructions for your chosen target database type:
2323

2424
* :ref:`db-config-mysql-label`
2525
* :ref:`db-config-postgresql-label`
@@ -36,7 +36,7 @@ The ``occ db:convert-type`` command handles all the tasks of the conversion. The
3636

3737
sudo -E -u www-data php occ db:convert-type [options] type username hostname database
3838

39-
``type`` should be the target database type. The same values are available here as for the ``config.php`` ``dbtype`` parameter. It should be one of: ``mysql`` for MariaDB/MySQL,
39+
``type`` should be the target database type. The same values are available here as for the ``config.php`` ``dbtype`` parameter. It should be one of: ``mysql`` for MariaDB/MySQL,
4040
``pgsql`` for PostgreSQL, or ``oci`` for Oracle.
4141

4242
The options:
@@ -57,8 +57,8 @@ Let's convert our existing (functioning) sqlite3 installation to be MariaDB/MySQ
5757

5858
sudo -E -u www-data php occ db:convert-type --password="<password>" --port="3306" --all-apps mysql <username> <hostname> nextcloud
5959

60-
.. note:: It was unnecessary to specify the port in this example because ``3306`` is already the default. We did so
61-
merely for demonstration purposes and completeness in case the reader is using a non-standard port on their target
60+
.. note:: It was unnecessary to specify the port in this example because ``3306`` is already the default. We did so
61+
merely for demonstration purposes and completeness in case the reader is using a non-standard port on their target
6262
database server.
6363

6464
On success the converter will automatically configure the new database in your
@@ -70,7 +70,7 @@ If you are converting to a MySQL/MariaDB database, you will also want to set ``m
7070

7171
sudo -E -u www-data php occ config:system:set mysql.utf8mb4 --type boolean --value="true"
7272

73-
If you like, you can view the changes that were made by looking for the ``db*`` parameters in your ``config.php`` (you could also use this command before
73+
If you like, you can view the changes that were made by looking for the ``db*`` parameters in your ``config.php`` (you could also use this command before
7474
doing the conversion to compare your configuration before/after):
7575

7676
::

admin_manual/configuration_database/linux_database_configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Adjust the paths to the pem files for your environment.
193193
PostgreSQL database
194194
^^^^^^^^^^^^^^^^^^^
195195

196-
In order to run Nextcloud securely on PostgreSQL, it is assumed that only
196+
In order to run Nextcloud securely on PostgreSQL, it is assumed that only
197197
Nextcloud uses this database and thus only one user accesses the database.
198198
For further services and users, we recommend to create a separate
199199
database or PostgreSQL instance.

0 commit comments

Comments
 (0)