nextcloud-desktop/doc
BMerz c3ff24faca Update README.md
Signed-off-by: BMerz <benedikt.merz@web.de>
2022-09-10 11:51:46 +02:00
..
_shared_assets Latest refinements 2018-02-01 15:57:37 +01:00
dev Build current documentation 2018-01-29 01:19:47 +01: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
advancedusage.rst Build current documentation 2018-01-29 01:19:47 +01: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 Only build app bundle if requested 2021-11-23 11:41:29 +00:00
CMakeLists.txt Fix cmake build of documentation 2018-11-05 10:56:21 +01:00
conf.py master is now 3.6.50 2022-09-06 09:35:09 +02:00
conffile.rst Update documentation. 2022-06-22 16:10:19 +02:00
conflicts.rst Change ownCloud reference to Nextcloud 2020-07-19 11:36:34 -07:00
envvars.rst Documented the usage of environment variables. 2017-03-24 12:26:46 +01:00
faq.rst Show a tray message when a folder watcher becomes unreliable #6119 2018-08-28 17:04:25 +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 Bump up minimum macOS version 2022-05-23 13:22:50 +02:00
introduction.rst Update improvements and news in the documentation 2021-07-28 12:59:36 +00: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
Makefile Build current documentation 2018-01-29 01:19:47 +01:00
navigating.rst docs: Replace "preceded" with "followed" 2022-05-06 09:26:10 +02:00
nextcloudcmd.rst Update nextcloudcmd documentation. 2021-08-26 10:38:06 +03: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 Update documentation. 2022-06-22 16:10:19 +02:00
visualtour.rst Double-clicking tray icon opens currently-selected user's local folder (if available) 2022-08-02 19:06:44 +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.