desktop/doc
Josh f66fb97b30 fix(docs): parameter promptDeleteAllFiles defaults to false not true
The default was changed to false in #1201 

Signed-off-by: Josh <josh.t.richards@gmail.com>
2024-03-20 10:09:39 +01:00
..
_shared_assets Fix typos found by codespell 2023-06-21 08:47:13 +02:00
dev Fix typos found by codespell 2023-06-21 08:47:13 +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 Documentation for mass deployment and account wizard override. 2023-06-20 11:17:14 +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 Fix typos found by codespell 2023-06-21 08:47:13 +02:00
conf.py starts the development of version 3.13 2024-01-29 17:44:15 +01:00
conffile.rst fix(docs): parameter promptDeleteAllFiles defaults to false not true 2024-03-20 10:09:39 +01: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 Update the documentation with information on how 'Edit locally' works. 2023-06-29 14:28:32 +00: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 we require version 12.0+ for macOS 2023-10-26 10:12:05 +02:00
introduction.rst Fix typos found by codespell 2023-06-21 08:47:13 +02:00
logo-blue.pdf
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 docs(troubleshooting) Add warning about sensitive data in logs 2023-11-28 10:02:00 +01:00
visualtour.rst Fix new typos found by codespell 2023-09-17 10:41:38 +02:00
wizardaccountsetupcommandline.rst Documentation for mass deployment and account wizard override. 2023-06-20 11:17:14 +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.