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

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.