desktop/doc
Josh 57db11e331 docs: conf file option moveToTrash is no longer Linux specific
Since #5698 / #3362 this option is no longer restricted to Linux. (It's also now in the GUI too).

Signed-off-by: Josh <josh.t.richards@gmail.com>
2024-08-28 11:38:02 +02:00
..
_shared_assets Fix typos found by codespell 2023-06-21 08:47:13 +02:00
dev Remove duplicated instructions. 2024-05-14 10:28:17 +02:00
images Add screenshots of the latest features. 2022-01-11 11:40:15 +00:00
scripts License: Adjust license of GPLv2 source files to GPLv2+ 2016-10-25 11:06:54 +02:00
CMakeLists.txt Fix cmake build of documentation 2018-11-05 10:56:21 +01:00
Makefile Build current documentation 2018-01-29 01:19:47 +01:00
README.md Update README.md 2022-09-10 11:51:46 +02:00
advancedusage.rst Fix header underline warnings in docs 2024-08-22 11:05:59 +02:00
architecture.rst Implement URI handler for local file editing 2022-08-03 11:38:33 +03:00
autoupdate.rst Update autoupdater doc with info about the macOS autoupdater 2022-05-24 16:32:46 +02:00
building.rst Improve text about %PATH% and KDE Craft. 2024-05-14 10:28:17 +02:00
conf.py master is now the next feature release (i.e. v3.15.0) 2024-08-23 11:19:08 +02:00
conffile.rst docs: conf file option moveToTrash is no longer Linux specific 2024-08-28 11:38:02 +02:00
conflicts.rst Fix typos found by codespell 2023-06-21 08:47:13 +02:00
envvars.rst Documented the usage of environment variables. 2017-03-24 12:26:46 +01:00
faq.rst Extend 'How the "Edit locally" functionality works' text. 2024-05-15 15:42:23 +02:00
glossary.rst Mac OS X is now macOS 2018-06-04 11:44:03 +02:00
index.rst Doc: Explaining conflict files and resolving them #6396 2018-07-03 10:18:20 +02:00
installing.rst update doc with install requirements for Qt6 supported platforms 2024-05-15 15:49:53 +02:00
introduction.rst Fix typos found by codespell 2023-06-21 08:47:13 +02:00
logo-blue.pdf Documentation: Fix PDF logo, version number 2015-11-17 12:55:41 +01:00
lowdiskspace.rst Build current documentation 2018-01-29 01:19:47 +01:00
massdeploymentcommandline.rst Fix residual typos found by codespell 2023-06-22 17:47:20 +02:00
navigating.rst Fix typos found by codespell 2023-06-21 08:47:13 +02:00
nextcloudcmd.rst Update nextcloudcmd.rst 2023-04-23 23:42:03 +08:00
options.rst Document --background 2021-06-02 21:22:59 +03:00
troubleshooting.rst Fix table warning in troubleshooting doc 2024-08-22 11:05:59 +02:00
visualtour.rst Fix new typos found by codespell 2023-09-17 10:41:38 +02:00
wizardaccountsetupcommandline.rst Fix string warning in account setup commandline doc 2024-08-22 11:05:59 +02:00

README.md

Desktop client documentation

The main nextcloud Documentation is found at https://github.com/nextcloud/documentation

The rst files from the current stable branch will be parsed with sphinx to be used at https://docs.nextcloud.com/desktop/latest/

Dependencies

You will need to have Sphinx, which comes packaged with Python 3.

In addition, run the following to install PdfLatex and Doxygen.

  • On Linux:
$ sudo apt install doxygen python texlive-latex-base texlive-latex-extra

Note: You may use something other than apt depending on your distribution.

% brew install basictex doxygen python

How to build the documentation

In your repositories directory:

$ git clone https://github.com/nextcloud/desktop.git
$ cd desktop
$ cd doc
$ sphinx-build -b html -D html_theme='nextcloud_com' -d _build/doctrees   . _build/html/com

The documentation html files will be at desktop/docs/_build/html/com.