nextcloud-desktop/doc
Felix Weilbach e2d0481c64 Add CMake option to enable address sanitizers
Signed-off-by: Felix Weilbach <felix.weilbach@nextcloud.com>
2021-05-17 11:43:55 +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 Added documentation for VFS and Status Feature. 2021-04-13 10:18:27 +03: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 Documentation. Fix incorrect syntax warnings and incorrect indentation before image elements. 2021-04-19 10:32:53 +03:00
autoupdate.rst Update autoupdate.rst 2020-01-30 10:12:56 +01: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 update version of documentation to the latest release (v3.2.1) 2021-04-30 07:28:58 +00:00
conffile.rst Remove maxLogLines config option 2020-12-15 10:58:55 +01: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 Update installing.rst 2021-04-27 17:20:54 +00:00
introduction.rst update the news part of documentation with improvements from 3.2 release 2021-04-26 16:37: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
Makefile Build current documentation 2018-01-29 01:19:47 +01:00
navigating.rst Updated the description on file manager integration on Linux 2021-04-26 07:03:50 +00:00
nextcloudcmd.rst Documentation. Fix incorrect syntax warnings and incorrect indentation before image elements. 2021-04-19 10:32:53 +03:00
options.rst Documentation. Fix incorrect syntax warnings and incorrect indentation before image elements. 2021-04-19 10:32:53 +03:00
README.md Update OSX build instructions 2021-03-01 15:26:32 +00:00
troubleshooting.rst Documentation: break line in config example. 2021-02-02 10:51:34 +01:00
visualtour.rst Change »Details…« to »View more activity…« 2019-05-28 01:14:31 +03: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.