Matthieu Gallien d75d635411 prepare 3.9.0-rc4 2 years ago
..
_shared_assets 545a406997 Latest refinements 8 years ago
dev fe102f359c Build current documentation 8 years ago
images 39faeffe09 Add screenshots of the latest features. 4 years ago
scripts db24f60ae3 License: Adjust license of GPLv2 source files to GPLv2+ 9 years ago
CMakeLists.txt abac2c327e Fix cmake build of documentation 7 years ago
Makefile fe102f359c Build current documentation 8 years ago
README.md c3ff24faca Update README.md 3 years ago
advancedusage.rst fe102f359c Build current documentation 8 years ago
architecture.rst d42d3c057f Implement URI handler for local file editing 3 years ago
autoupdate.rst 804cef2bff Update autoupdater doc with info about the macOS autoupdater 3 years ago
building.rst ec64246dc7 Only build app bundle if requested 4 years ago
conf.py d75d635411 prepare 3.9.0-rc4 2 years ago
conffile.rst 71dbd1103f Update documentation. 3 years ago
conflicts.rst c4e8211687 Change ownCloud reference to Nextcloud 5 years ago
envvars.rst 090d02a65f Documented the usage of environment variables. 9 years ago
faq.rst 2844c925eb Show a tray message when a folder watcher becomes unreliable #6119 7 years ago
glossary.rst 78bfae45ae Mac OS X is now macOS 7 years ago
index.rst 4fa6fff1a9 Doc: Explaining conflict files and resolving them #6396 7 years ago
installing.rst 95df4b98be Bump up minimum macOS version 3 years ago
introduction.rst 55067c55a7 Update improvements and news in the documentation 4 years ago
logo-blue.pdf 914df32587 Documentation: Fix PDF logo, version number 10 years ago
lowdiskspace.rst fe102f359c Build current documentation 8 years ago
navigating.rst 331b675571 docs: Replace "preceded" with "followed" 3 years ago
nextcloudcmd.rst 360100844c Update nextcloudcmd.rst 2 years ago
options.rst f4b1ba45b8 Document --background 4 years ago
troubleshooting.rst 71dbd1103f Update documentation. 3 years ago
visualtour.rst 2b598d1820 Double-clicking tray icon opens currently-selected user's local folder (if available) 3 years ago

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

  • On macOS (via Homebrew):

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