Jani Uusitalo f4b1ba45b8 Document --background 4 rokov pred
..
_shared_assets 545a406997 Latest refinements 8 rokov pred
dev fe102f359c Build current documentation 8 rokov pred
images b4d01afd86 Added documentation for VFS and Status Feature. 4 rokov pred
scripts db24f60ae3 License: Adjust license of GPLv2 source files to GPLv2+ 9 rokov pred
CMakeLists.txt abac2c327e Fix cmake build of documentation 7 rokov pred
Makefile fe102f359c Build current documentation 8 rokov pred
README.md b33ea05271 Update OSX build instructions 5 rokov pred
advancedusage.rst fe102f359c Build current documentation 8 rokov pred
architecture.rst 21d39dea87 Documentation. Fix incorrect syntax warnings and incorrect indentation before image elements. 4 rokov pred
autoupdate.rst 4e83f3d525 Update autoupdate.rst 6 rokov pred
building.rst e2d0481c64 Add CMake option to enable address sanitizers 4 rokov pred
conf.py 55f91e2cb7 update version of documentation to the latest release (v3.2.1) 4 rokov pred
conffile.rst 18e1098e38 Remove maxLogLines config option 5 rokov pred
conflicts.rst c4e8211687 Change ownCloud reference to Nextcloud 5 rokov pred
envvars.rst 090d02a65f Documented the usage of environment variables. 9 rokov pred
faq.rst 2844c925eb Show a tray message when a folder watcher becomes unreliable #6119 7 rokov pred
glossary.rst 78bfae45ae Mac OS X is now macOS 7 rokov pred
index.rst 4fa6fff1a9 Doc: Explaining conflict files and resolving them #6396 7 rokov pred
installing.rst 20a2c42963 Update installing.rst 4 rokov pred
introduction.rst 0aca5d616c update the news part of documentation with improvements from 3.2 release 4 rokov pred
logo-blue.pdf 914df32587 Documentation: Fix PDF logo, version number 10 rokov pred
lowdiskspace.rst fe102f359c Build current documentation 8 rokov pred
navigating.rst 5e0385381f Updated the description on file manager integration on Linux 4 rokov pred
nextcloudcmd.rst 21d39dea87 Documentation. Fix incorrect syntax warnings and incorrect indentation before image elements. 4 rokov pred
options.rst f4b1ba45b8 Document --background 4 rokov pred
troubleshooting.rst 3087a09c45 Documentation: break line in config example. 5 rokov pred
visualtour.rst bcdc88ecf0 Change »Details…« to »View more activity…« 6 rokov pred

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.