Elsie Hupp b33ea05271 Update OSX build instructions 5 лет назад
..
_shared_assets 545a406997 Latest refinements 8 лет назад
dev fe102f359c Build current documentation 8 лет назад
images bba376e944 Update documentation with the new 3.1 option to "Create Debug Archive". 5 лет назад
scripts db24f60ae3 License: Adjust license of GPLv2 source files to GPLv2+ 9 лет назад
CMakeLists.txt abac2c327e Fix cmake build of documentation 7 лет назад
Makefile fe102f359c Build current documentation 8 лет назад
README.md b33ea05271 Update OSX build instructions 5 лет назад
advancedusage.rst fe102f359c Build current documentation 8 лет назад
architecture.rst 5f7fd7c551 Excludes: Expand doc, Desktop.ini only in root folder 7 лет назад
autoupdate.rst 4e83f3d525 Update autoupdate.rst 6 лет назад
building.rst b33ea05271 Update OSX build instructions 5 лет назад
conf.py cbea02390e Update copyright date and version displayed in the page title. 5 лет назад
conffile.rst 18e1098e38 Remove maxLogLines config option 5 лет назад
conflicts.rst c4e8211687 Change ownCloud reference to Nextcloud 5 лет назад
envvars.rst 090d02a65f Documented the usage of environment variables. 9 лет назад
faq.rst 2844c925eb Show a tray message when a folder watcher becomes unreliable #6119 7 лет назад
glossary.rst 78bfae45ae Mac OS X is now macOS 7 лет назад
index.rst 4fa6fff1a9 Doc: Explaining conflict files and resolving them #6396 7 лет назад
installing.rst b552c77128 Docs: Be slightly more modern and use 64-bit examples 5 лет назад
introduction.rst 78bfae45ae Mac OS X is now macOS 7 лет назад
logo-blue.pdf 914df32587 Documentation: Fix PDF logo, version number 10 лет назад
lowdiskspace.rst fe102f359c Build current documentation 8 лет назад
navigating.rst eb0e7fa032 Correct incorrect reference to OSX Menu bar 5 лет назад
nextcloudcmd.rst 891c192ebc Add install instructions for nextcloudcmd 5 лет назад
options.rst d338c130af added logdebug 7 лет назад
troubleshooting.rst 3087a09c45 Documentation: break line in config example. 5 лет назад
visualtour.rst bcdc88ecf0 Change »Details…« to »View more activity…« 6 лет назад

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.