Matthieu Gallien d02a998aa3 prepare release 3.9.1 il y a 2 ans
..
_shared_assets 50c3700412 Fix typos found by codespell il y a 2 ans
dev 50c3700412 Fix typos found by codespell il y a 2 ans
images 39faeffe09 Add screenshots of the latest features. il y a 4 ans
scripts db24f60ae3 License: Adjust license of GPLv2 source files to GPLv2+ il y a 9 ans
CMakeLists.txt abac2c327e Fix cmake build of documentation il y a 7 ans
Makefile fe102f359c Build current documentation il y a 8 ans
README.md c3ff24faca Update README.md il y a 3 ans
advancedusage.rst cd0195128f Documentation for mass deployment and account wizard override. il y a 2 ans
architecture.rst d42d3c057f Implement URI handler for local file editing il y a 3 ans
autoupdate.rst 804cef2bff Update autoupdater doc with info about the macOS autoupdater il y a 3 ans
building.rst 50c3700412 Fix typos found by codespell il y a 2 ans
conf.py d02a998aa3 prepare release 3.9.1 il y a 2 ans
conffile.rst 50c3700412 Fix typos found by codespell il y a 2 ans
conflicts.rst 50c3700412 Fix typos found by codespell il y a 2 ans
envvars.rst 090d02a65f Documented the usage of environment variables. il y a 9 ans
faq.rst 4299b1e91d Update the documentation with information on how 'Edit locally' works. il y a 2 ans
glossary.rst 78bfae45ae Mac OS X is now macOS il y a 7 ans
index.rst 4fa6fff1a9 Doc: Explaining conflict files and resolving them #6396 il y a 7 ans
installing.rst 95df4b98be Bump up minimum macOS version il y a 3 ans
introduction.rst 50c3700412 Fix typos found by codespell il y a 2 ans
logo-blue.pdf 914df32587 Documentation: Fix PDF logo, version number il y a 10 ans
lowdiskspace.rst fe102f359c Build current documentation il y a 8 ans
massdeploymentcommandline.rst cd0195128f Documentation for mass deployment and account wizard override. il y a 2 ans
navigating.rst 50c3700412 Fix typos found by codespell il y a 2 ans
nextcloudcmd.rst 360100844c Update nextcloudcmd.rst il y a 2 ans
options.rst f4b1ba45b8 Document --background il y a 4 ans
troubleshooting.rst 71dbd1103f Update documentation. il y a 3 ans
visualtour.rst 50c3700412 Fix typos found by codespell il y a 2 ans
wizardaccountsetupcommandline.rst cd0195128f Documentation for mass deployment and account wizard override. il y a 2 ans

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.