desktop/doc
Matthieu Gallien 733063d1ce
master is now 3.6.50
Signed-off-by: Matthieu Gallien <matthieu.gallien@nextcloud.com>
2022-09-06 09:35:09 +02:00
..
_shared_assets
dev
images Add screenshots of the latest features. 2022-01-11 11:40:15 +00:00
scripts
CMakeLists.txt
Makefile
README.md Update OSX build instructions 2021-03-01 15:26:32 +00:00
advancedusage.rst
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
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
faq.rst
glossary.rst
index.rst
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
lowdiskspace.rst
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
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

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.