desktop/doc
Jos Poortvliet cd598a00f7 Documentation: E2EE and VFS
Describe the relation between E2EE and VFS.

Signed-off-by: Jos Poortvliet <jospoortvliet@gmail.com>
2021-04-19 09:24:11 +03:00
..
_shared_assets
dev
images Added documentation for VFS and Status Feature. 2021-04-13 10:18:27 +03:00
scripts
CMakeLists.txt
Makefile
README.md Update OSX build instructions 2021-03-01 15:26:32 +00:00
advancedusage.rst
architecture.rst Documentation: E2EE and VFS 2021-04-19 09:24:11 +03:00
autoupdate.rst
building.rst Update OSX build instructions 2021-03-01 15:26:32 +00:00
conf.py
conffile.rst Remove maxLogLines config option 2020-12-15 10:58:55 +01:00
conflicts.rst
envvars.rst
faq.rst
glossary.rst
index.rst
installing.rst Update documentation for the account wizard 2021-03-29 12:10:37 +00:00
introduction.rst
logo-blue.pdf
lowdiskspace.rst
navigating.rst Correct incorrect reference to OSX Menu bar 2020-12-15 10:57:52 +01:00
nextcloudcmd.rst
options.rst
troubleshooting.rst Documentation: break line in config example. 2021-02-02 10:51:34 +01:00
visualtour.rst

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.