nextcloud-desktop/doc
Matthieu Gallien 8caa014311
master branch will be 3.16.0 future release
Signed-off-by: Matthieu Gallien <matthieu.gallien@nextcloud.com>
2024-11-22 12:05:06 +01: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 section on configuration for macosvfs docs 2024-11-17 22:23:45 +08:00
scripts License: Adjust license of GPLv2 source files to GPLv2+ 2016-10-25 11:06:54 +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
CMakeLists.txt Fix cmake build of documentation 2018-11-05 10:56:21 +01:00
conf.py master branch will be 3.16.0 future release 2024-11-22 12:05:06 +01: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 Add starter documentation page on macOS VFS 2024-11-17 22:23:45 +08: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
macosvfs.rst Add section on configuration for macosvfs docs 2024-11-17 22:23:45 +08:00
Makefile 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 doc/nextcloudcmd.rst 2024-11-15 09:25:42 +01:00
options-cmd.rst Incorporate doc fixes from pull request #6122 2024-10-18 13:33:59 +08:00
options.rst Document --background 2021-06-02 21:22:59 +03:00
README.md Update README.md 2022-09-10 11:51:46 +02:00
troubleshooting.rst Add section on Apple ATS to docs troubleshooting section 2024-11-14 15:46:38 +08: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

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.