Felix Weilbach b6108cb9fe Make virtual files feature documentation more understandable 4 lat temu
..
_shared_assets 545a406997 Latest refinements 8 lat temu
dev fe102f359c Build current documentation 8 lat temu
images 65f2fd2450 Add documentation for user status selector dialog 4 lat temu
scripts db24f60ae3 License: Adjust license of GPLv2 source files to GPLv2+ 9 lat temu
CMakeLists.txt abac2c327e Fix cmake build of documentation 7 lat temu
Makefile fe102f359c Build current documentation 8 lat temu
README.md b33ea05271 Update OSX build instructions 5 lat temu
advancedusage.rst fe102f359c Build current documentation 8 lat temu
architecture.rst b6108cb9fe Make virtual files feature documentation more understandable 4 lat temu
autoupdate.rst 41ecb2c160 macOS client is not able to do auto updates 4 lat temu
building.rst e2d0481c64 Add CMake option to enable address sanitizers 4 lat temu
conf.py efd9c6ef45 Bump version to 3.3.50 4 lat temu
conffile.rst 2c95b9519c Set default maxChunkSize to 1000MB 4 lat temu
conflicts.rst c4e8211687 Change ownCloud reference to Nextcloud 5 lat temu
envvars.rst 090d02a65f Documented the usage of environment variables. 9 lat temu
faq.rst 2844c925eb Show a tray message when a folder watcher becomes unreliable #6119 7 lat temu
glossary.rst 78bfae45ae Mac OS X is now macOS 7 lat temu
index.rst 4fa6fff1a9 Doc: Explaining conflict files and resolving them #6396 7 lat temu
installing.rst 22b10e20e4 Update supported server versions 4 lat temu
introduction.rst 55067c55a7 Update improvements and news in the documentation 4 lat temu
logo-blue.pdf 914df32587 Documentation: Fix PDF logo, version number 10 lat temu
lowdiskspace.rst fe102f359c Build current documentation 8 lat temu
navigating.rst 65f2fd2450 Add documentation for user status selector dialog 4 lat temu
nextcloudcmd.rst 4927e48bf3 Update nextcloudcmd documentation. 4 lat temu
options.rst f4b1ba45b8 Document --background 4 lat temu
troubleshooting.rst 3e61bdc431 Use dav instead of webdav 4 lat temu
visualtour.rst 2c556857e0 Update visual tour in documentation 4 lat temu

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.

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