desktop/doc
Felix Weilbach b6108cb9fe Make virtual files feature documentation more understandable
Signed-off-by: Felix Weilbach <felix.weilbach@nextcloud.com>
2021-09-27 20:42:19 +00:00
..
_shared_assets
dev
images Add documentation for user status selector dialog 2021-09-17 08:22:52 +00:00
scripts
CMakeLists.txt
Makefile
README.md
advancedusage.rst
architecture.rst Make virtual files feature documentation more understandable 2021-09-27 20:42:19 +00:00
autoupdate.rst macOS client is not able to do auto updates 2021-09-06 11:39:08 +02:00
building.rst Add CMake option to enable address sanitizers 2021-05-17 11:43:55 +00:00
conf.py Bump version to 3.3.50 2021-07-29 10:47:24 +02:00
conffile.rst Set default maxChunkSize to 1000MB 2021-07-30 07:00:09 +00:00
conflicts.rst
envvars.rst
faq.rst
glossary.rst
index.rst
installing.rst Update supported server versions 2021-07-29 10:00:45 +00:00
introduction.rst Update improvements and news in the documentation 2021-07-28 12:59:36 +00:00
logo-blue.pdf
lowdiskspace.rst
navigating.rst Add documentation for user status selector dialog 2021-09-17 08:22:52 +00:00
nextcloudcmd.rst Update nextcloudcmd documentation. 2021-08-26 10:38:06 +03:00
options.rst Document --background 2021-06-02 21:22:59 +03:00
troubleshooting.rst Use dav instead of webdav 2021-07-16 12:42:02 +00:00
visualtour.rst Update visual tour in documentation 2021-06-25 17:40:53 +00:00

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.

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