1
0
Fork 0
Nextcloud-Desktop/doc
Felix Weilbach 7faa80c1e1 Update documentation for the account wizard
This update is necessary because of the following commit:
b5cf820b42

Signed-off-by: Felix Weilbach <felix.weilbach@nextcloud.com>
2021-03-29 12:10:37 +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 Update documentation for the account wizard 2021-03-29 12:10:37 +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 OSX build instructions 2021-03-01 15:26:32 +00:00
advancedusage.rst Build current documentation 2018-01-29 01:19:47 +01:00
architecture.rst Excludes: Expand doc, Desktop.ini only in root folder 2018-05-16 20:29:12 +02:00
autoupdate.rst Update autoupdate.rst 2020-01-30 10:12:56 +01:00
building.rst Update OSX build instructions 2021-03-01 15:26:32 +00:00
conf.py Update copyright date and version displayed in the page title. 2020-08-25 18:50:14 +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 documentation for the account wizard 2021-03-29 12:10:37 +00:00
introduction.rst Mac OS X is now macOS 2018-06-04 11:44:03 +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
navigating.rst Correct incorrect reference to OSX Menu bar 2020-12-15 10:57:52 +01:00
nextcloudcmd.rst Add install instructions for nextcloudcmd 2020-06-03 16:10:55 +02:00
options.rst added logdebug 2018-09-09 21:36:47 +02: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

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/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.