2020-09-08 16:09:31 +03:00
|
|
|
# Desktop client documentation
|
|
|
|
|
|
2021-02-26 21:59:25 +03:00
|
|
|
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](https://www.sphinx-doc.org), 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](https://brew.sh/)):
|
|
|
|
|
```
|
|
|
|
|
% brew install basictex doxygen python
|
|
|
|
|
```
|
2020-09-08 16:09:31 +03:00
|
|
|
|
|
|
|
|
## How to build the documentation
|
|
|
|
|
|
2021-02-26 21:59:25 +03:00
|
|
|
In your repositories directory:
|
2020-09-08 16:09:31 +03:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ git clone https://github.com/nextcloud/desktop.git
|
|
|
|
|
$ cd desktop
|
2021-01-12 20:07:36 +03:00
|
|
|
$ cd doc
|
2020-09-08 16:09:31 +03:00
|
|
|
$ 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```.
|
