nextcloud-desktop/doc
Matthieu Gallien 2665c8fc16 we run on Windows 8.1+
Signed-off-by: Matthieu Gallien <matthieu.gallien@nextcloud.com>
2021-11-15 13:40:51 +00: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 documentation for user status selector dialog 2021-09-17 08:22:52 +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 Make virtual files feature documentation more understandable 2021-09-27 20:42:19 +00:00
autoupdate.rst macOS client is not able to do auto updates 2021-09-06 11:39:08 +02:00
building.rst Add CMake option to enable address sanitizers 2021-05-17 11:43:55 +00:00
CMakeLists.txt Fix cmake build of documentation 2018-11-05 10:56:21 +01:00
conf.py Bump to version 3.4.0-rc1 2021-11-11 10:39:51 +01:00
conffile.rst Set default maxChunkSize to 1000MB 2021-07-30 07:00:09 +00: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 we run on Windows 8.1+ 2021-11-15 13:40:51 +00: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 Add documentation for user status selector dialog 2021-09-17 08:22:52 +00: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 OSX build instructions 2021-03-01 15:26:32 +00:00
troubleshooting.rst Use dav instead of webdav 2021-07-16 12:42:02 +00:00
visualtour.rst Update visual tour in documentation 2021-06-25 17:40:53 +00: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/3.0/

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.