From 407a2d70c4175ef70fd2f949a2b116ca922891fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Sat, 18 Jan 2020 12:17:20 +0100 Subject: [PATCH] Move to python3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- .drone.yml | 18 ---------- .github/workflows/sphinxbuild.yml | 36 ++++++++++++++++++++ Pipfile | 15 ++++++++ admin_manual/Makefile | 2 +- admin_manual/conf.py | 5 ++- admin_manual/installation/example_centos.rst | 6 ++-- developer_manual/Makefile | 2 +- developer_manual/conf.py | 2 +- requirements.txt | 3 +- user_manual/Makefile | 2 +- user_manual/files/access_webdav.rst | 30 ++++++++-------- 11 files changed, 76 insertions(+), 45 deletions(-) delete mode 100644 .drone.yml create mode 100644 .github/workflows/sphinxbuild.yml create mode 100644 Pipfile diff --git a/.drone.yml b/.drone.yml deleted file mode 100644 index 260a19ec3..000000000 --- a/.drone.yml +++ /dev/null @@ -1,18 +0,0 @@ -kind: pipeline -name: documentation - -steps: -- name: documentation - image: nextcloudci/documentation:documentation-9 - commands: - - npm install svgexport@0.3.2 -g - - pip2 install -r requirements.txt - - make all - -trigger: - branch: - - master - - stable* - event: - - pull_request - - push diff --git a/.github/workflows/sphinxbuild.yml b/.github/workflows/sphinxbuild.yml new file mode 100644 index 000000000..56f2820ee --- /dev/null +++ b/.github/workflows/sphinxbuild.yml @@ -0,0 +1,36 @@ +name: "Pull Request Docs Check" +on: +- pull_request +- push + +jobs: + user_manual: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "user_manual/" + pre-build-command: pip install -r requirements.txt + build-command: make html + repo-token: "${{ secrets.GITHUB_TOKEN }}" + developer_manual: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "developer_manual/" + pre-build-command: pip install -r requirements.txt + build-command: make html + repo-token: "${{ secrets.GITHUB_TOKEN }}" + admin_manual: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "admin_manual/" + pre-build-command: pip install -r requirements.txt + build-command: make html + repo-token: "${{ secrets.GITHUB_TOKEN }}" diff --git a/Pipfile b/Pipfile new file mode 100644 index 000000000..a263af5c2 --- /dev/null +++ b/Pipfile @@ -0,0 +1,15 @@ +[[source]] +name = "pypi" +url = "https://pypi.org/simple" +verify_ssl = true + +[dev-packages] + +[packages] +rst2pdf = "*" +sphinx-rtd-theme = "*" +Sphinx = "*" +Pillow = "*" + +[requires] +python_version = "3.8" diff --git a/admin_manual/Makefile b/admin_manual/Makefile index 797122e30..8bcf2db09 100644 --- a/admin_manual/Makefile +++ b/admin_manual/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS += SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build diff --git a/admin_manual/conf.py b/admin_manual/conf.py index a9c42d0b3..28882aed0 100644 --- a/admin_manual/conf.py +++ b/admin_manual/conf.py @@ -29,7 +29,7 @@ from conf import * # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions += ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx'] +extensions += ['sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx'] # Add any paths that contain templates here, relative to this directory. templates_path = ['../_shared_assets/templates'] @@ -175,8 +175,7 @@ htmlhelp_basename = 'NextcloudServerAdminManual' # -- Options for LaTeX output -------------------------------------------------- -latex_elements = {'preamble': '\usepackage{morefloats}', 'figure_align': 'H', -} +latex_elements = {'preamble': '\\usepackage{morefloats}', 'figure_align': 'H',} # latex_elements = { # The paper size ('letterpaper' or 'a4paper'). diff --git a/admin_manual/installation/example_centos.rst b/admin_manual/installation/example_centos.rst index 2547126b5..620628f3e 100644 --- a/admin_manual/installation/example_centos.rst +++ b/admin_manual/installation/example_centos.rst @@ -22,7 +22,7 @@ Apache yum install -y httpd -See :ref:`apache-web-server-configuration` for details. +See :ref:`apache_configuration_label` for details. Make sure the apache web service is enabled and started:: @@ -63,7 +63,7 @@ Command to install the yum-utils package (for the yum-config-manager command): dnf install yum-utils -You want a single version which means replacing base packages from the distribution. Packages have the same name than the base repository, ie php-*. Some common dependencies are available in remi-safe repository, which is enabled by default. +You want a single version which means replacing base packages from the distribution. Packages have the same name than the base repository, ie php-\*. Some common dependencies are available in remi-safe repository, which is enabled by default. You have to enable the module stream for 7.4: @@ -117,7 +117,7 @@ Improve MariaDB security.:: After you have done this, make sure you create a database with a username and password so that Nextcloud will have access to it. For further details on database setup and configuration, - see the :doc:`../configuration_database/linux_database_configuration` documentation. +see the :doc:`../configuration_database/linux_database_configuration` documentation. Redis diff --git a/developer_manual/Makefile b/developer_manual/Makefile index 797122e30..8bcf2db09 100644 --- a/developer_manual/Makefile +++ b/developer_manual/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS += SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build diff --git a/developer_manual/conf.py b/developer_manual/conf.py index 425542ee6..f1a11bd37 100644 --- a/developer_manual/conf.py +++ b/developer_manual/conf.py @@ -29,7 +29,7 @@ from conf import * # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions += ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx'] +extensions += ['sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx'] # Add any paths that contain templates here, relative to this directory. templates_path = ['../_shared_assets/templates'] diff --git a/requirements.txt b/requirements.txt index 8c49f479e..88cbdd574 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,4 @@ sphinx -sphinxcontrib-phpdomain rst2pdf pillow -sphinx_rtd_theme \ No newline at end of file +sphinx-rtd-theme diff --git a/user_manual/Makefile b/user_manual/Makefile index 797122e30..8bcf2db09 100644 --- a/user_manual/Makefile +++ b/user_manual/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS += SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build diff --git a/user_manual/files/access_webdav.rst b/user_manual/files/access_webdav.rst index ca6962ccc..8b507f287 100644 --- a/user_manual/files/access_webdav.rst +++ b/user_manual/files/access_webdav.rst @@ -9,7 +9,7 @@ WebDAV. Before we get into configuring WebDAV, let's take a quick look at the recommended way of connecting client devices to your Nextcloud servers. .. note:: In the following examples, you should replace **example.com/nextcloud** with the - URL of your Nextcloud server (omit the directory part if the installation is + URL of your Nextcloud server (omit the directory part if the installation is in the root of your domain), and "USERNAME" with the username of the connecting user. See the webdav url (bottom left, settings) on your Nextcloud. @@ -17,12 +17,12 @@ recommended way of connecting client devices to your Nextcloud servers. Nextcloud Desktop and mobile clients ------------------------------------ -The recommended way to synchronize a desktop PC with a Nextcloud server is by -using `Nextcloud/ownCloud sync clients `_. You can configure the -client to save files in any local directory and you can choose which +The recommended way to synchronize a desktop PC with a Nextcloud server is by +using `Nextcloud/ownCloud sync clients `_. You can configure the +client to save files in any local directory and you can choose which directories on the Nextcloud server to sync with. The client displays the -current connection status and logs all activity, so you always know which -remote files have been downloaded to your PC and you can verify that files +current connection status and logs all activity, so you always know which +remote files have been downloaded to your PC and you can verify that files created and updated on your local PC are properly synchronized with the server. The recommended way to synchronize Nextcloud server with Android and @@ -151,7 +151,7 @@ automatically every time you log in to your Linux computer. https://example.com/nextcloud/remote.php/dav/files/USERNAME/ /home//nextcloud davfs user,rw,auto 0 0 - + 8. Then test that it mounts and authenticates by running the following command. If you set it up correctly you won't need root permissions:: @@ -228,14 +228,14 @@ Using this feature requires network connectivity. If you want to store your files offline, use the Desktop Client to sync all files on your Nextcloud to one or more directories of your local hard drive. -.. note:: Prior to mapping your drive, you must permit the use of Basic -Authentication in the Windows Registry: launch „regedit“ and navigate to -HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters. -Create or edit the DWORD value „BasicAuthLevel“ (Windows Vista, 7 and 8) or -„UseBasicAuth“ (Windows XP and Windows Server 2003) and set its value data -to 1 for SSL connections. Value 0 means that Basic Authentication is disabled, -a value of 2 allows both SSL and non-SSL connections (not recommended). -Then exit Registry Editor, and restart the computer. +.. note:: Prior to mapping your drive, you must permit the use of Basic + Authentication in the Windows Registry: launch „regedit“ and navigate to + HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters. + Create or edit the DWORD value „BasicAuthLevel“ (Windows Vista, 7 and 8) or + „UseBasicAuth“ (Windows XP and Windows Server 2003) and set its value data + to 1 for SSL connections. Value 0 means that Basic Authentication is disabled, + a value of 2 allows both SSL and non-SSL connections (not recommended). + Then exit Registry Editor, and restart the computer. Mapping drives with the command line ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^